FAP Files

The information that defines each section (formerly called an image) is stored in a FAP file. FAP files are text files with the extension FAP. You can edit FAP files using a text editor, but they are most commonly created and edited using Documaker Studio.

Record

Description

Image H

H Image Header Record

Image H1

A,H1 Image Header Attributes Record

Image H2

A,H2 Image Header Attributes Record

Image H3

A,H3 Image Header Attributes Record

Image H4

A,H4 Image Header Attributes Record

Image H5

A,H5 Image Header Attributes Record

Image H6

A,H6 Image Header Attributes Record

Image H7

A,H7 Image Header Attributes Record

Image H8

A,H8Logical Bottom from Normalized fileRecord

ImageH9

A,H9Minimum height for dynamic imageRecord

Image V

V Image Version Record

Barcode B

B Bar code Record

Barcode B1

A,B1 Barcode Attributes Record 1

Box S

S Shaded box Record (no longer used)

Box X

X Box, Shade, Line Record

Chart D

D Chart Record

Chart D1

A,D1 Chart Attributes Record 1

Chart DA

D,A Chart Series Label Record

Chart DA1

A,DA1 Chart Series Label Attributes Record 1

Chart DB

D,B Chart Custom Data Point Label Record

Chart DB1

A,DB1 Chart Custom Data Point Label Attributes Record

Chart DC

D,C Chart Area Record

Chart DC1

A,DC1 Chart Area Attributes Record 1

Chart DD

D,D Chart Data Record

Chart DE

D,E Chart Scale-Axis Record

Chart DE1

A,DE1 Chart Scale-Axis Attributes Record 1

Chart DE2

A,DE2 Chart Scale-Axis Attributes Record 2

Chart DK

A,DK Chart Linking Attributes Record 1

Chart DL

D,L Chart Legend Record

Chart DL1

A,DL1 Chart Legend Attributes Record 1

Chart DP

D,P Chart Point-Axis Record

Chart DP1

A,DP1 Chart Point-Axis Attributes Record 1

Chart DS

D,S Chart Series Record

Chart DS1

A,DS1 Chart Series Attributes Record 1

Chart DT

D,T Chart Title Record

Chart DT1

A,DT1 Chart Title Attributes Record 1

Chart DX

D,X Chart X-Axis Record (no longer used)

Chart DX1

A,DX1 Chart X-Axis Attributes Record 1 (no longer used)

Chart DY

D,Y Chart Y-Axis Record (no longer used)

Chart DY1

A,DY1 Chart Y-Axis Attributes Record 1 (no longer used)

Color C

C Color Record

Field F

F Field Record

Field F1

A,F1 Field Attributes Record 1

Field F2

A,F2 Field Attributes Record 2

Field F3

A,F3 Field Attributes Record 3

Field F4

A,F4 Field Attributes Record 4

Field F5

A,F5 Field Attributes Record 5

Field F6

A,F6 Field Attributes Record 6

Field F7

A,F7 Field Attributes Record 7

Field F8

A,F8 Field Attributes Record 8

Field F9

A,F9 Field Attributes Record 9

Field FB

A,FB Field Attributes Record FB

Field FC

A,FC Field Attributes Record FC

Font R

R Font Record

Font R1

A,R1 Font Attributes Record 1

Font R2

A,R2 Font Attributes Record 2 Syntax A,R2,fid,cgr,cw1,cw2,cw3,...,cw32

Font R3

A,R3 Font Attributes Record 3

Font R4

A,R4 Font Attributes Record 4

Font R5

A,R5 Font Attributes Record 5

Font R6

A,R5 Font Attributes Record 6

Graphic G

G Graphic/logo Record

Graphics BEGLOGO

\BEGLOGO\Graphic/logo Attributes

Graphics ENDLOGO

\ENDLOGO\Graphic/logo Attributes

Graphics G1

A,G1 Graphic/logo Attributes Record 1

Graphics G2

A,G2 Graphic/logo Attributes Record 2

Graphics G3

A,G3 Graphic/logo Attributes Record 3

Graphics G4

A,G4 Graphic/logo Attributes Record 4

Graphics G5

A,G5 Graphic/logo Attributes Record 5

Graphics G6

A,G6 Graphic/logo Attributes Record 6

Graphics G7

A,G7 Graphic/logo Attributes Record 7

Guideline L

L Guideline Record

Guideline L1

A,L1 Guideline Attributes Record 1

ImageRule J

L Image Rule Record

Line X1

A,X1 Box, Shade, Line Attributes Record 1

Line X2

A,X2 Box, Shade, Line Attributes Record 2

Line X3

A,X3 Border Flags Record 3

Note N

N Note Record

Note N1

A,N1 Note Attributes Record 1

Signature

Z, Signature token Record

Signature Z1

A,Z1 Document Metadata Record 1

Signature Z2

A,Z2 Signature Metadata Record 2

Table AQA
AQA Table Shading Attributes Record

Text Area AP1

A,P1 Paragraph Record Attributes Record

Text Area E

M,E Text Area End Record

Text Area G

M,G Text Area Graphic Record

Text Area L

M,L Text Area line Record (no longer used)

Text Area LL

M,LL Text Area Guide Line Record

Text Area MA

A,MA Text Area Attributes Record

Text Area MH1

A,MH1 Text Area Attributes Record 1

Text Area MH2 A,MH2 Text Area Attributes Record 2
Text Area MH4 A,MH4 Text Area Attributes Record 4

Text Area N

M,N Text Area Note Record

Text Area O

M,O Text Area format token Record

Text Area O1

M,O1 Text Area format token Record 1

Text Area P

M,P Text Area Paragraph Record

Text Area P1

M,P1 Text Area Paragraph Record 1

Text Area P2

M,P2 Text Area Paragraph Record 2

Text Area P3

M,P3 Text Area Paragraph Record 3

Text Area PX

M,PX Text Area Borders/Shades Record

Text Area T

M,T Text Area Text Record (no longer used)

Text Area TT

M,TT Text Area Text Record

Text Area X

M,X Text Area Box Record

Text T

T Text Record

Text T1

A,T1 Text Attributes Record 1

Text T2

A,T2 Text Attributes Record 2

Vector I

I Illustration Record

Vector I2

A,I2 Illustration Attributes Record 2

Vector I3

A,I3 Illustration Attributes Record 3

  

NA Files

The GenData program creates an NAFILE.DAT file, commonly referred to as the NA file, in which it stores section and field information. The GenPrint program uses this file, along with the POLFILE.DAT file, which is also produced by the GenData program to print the forms.

If the data is incomplete and the GenData program cannot complete the form, it creates a manual batch file. The GenWIP program then creates separate DAT and POL files for each incomplete transaction. These files provide the entry system with the information it needs to open the form so a data entry operator can add the missing data. This is a semicolon-delimited text file. You can see examples of this file in the sample resources.

Record

Description

NA

\NA=,,,,,,,,,\ Image Header Record

B

B;;;;;;;;\ Bar code Record

DA

DA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Series Label Record

DB

DB;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Custom Data Point Label Record

DC

DC;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Area Record

DD

DD;;\ Dynamic Chart Series Data Record

DE

DE;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Scale-Axis Record

DK

DK;;\ Dynamic Chart Link Record

DL

DL;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Legend Record

DN

DN;;\ Dynamic Chart Title Record

DP

DP;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Point-Axis Record

DS

DS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Series Record

DT

DT;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Title Record

DX

DX;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart X-Axis Record

DY

DY;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Y-Axis Record

EM

EM;\ End Multiline Field Structure

ENDDOCSET

\ENDDOCSET\ Form set Trailer Record

ENDFAP

\ENDFAP\ End in-line FAP file records

ENDFORM

\ENDFORM\ Form Trailer Record

F

F;;;;;;\ Field Data Record

FAP

\FAP\ Begin in-line FAP file records

L

L;;;;;;\ Old Multiline Field Line Attribute Record. NO LONGER USED!

M

M;;;;;;;;;;\ Multiline Field Structure

M1

M;;;;;;;;;;\ Object Type Structure

N

N;;;;;;;;\ Note Record

O

O;;;;;;;;;;;\ Multiline Format Record

OX

OX;;;;;\ Multiline Border or Shade Record

P

P;;;;;\ Multiline Field Paragraph Format Record

P3

P3;;;;;\ Text Area Format Record P3

PBG

PB;G;;;;;\ Text Area Format Record G

PBG1

PB;G1;;;;;\ Text Area Format Record G1

PBI

PB;I;;;;;\ Text Area Format Record I

PBI1

PB;I1;;;;;\ Text Area Format Record I1

PBT

PB;T;;;;;\ Text Area Format Record T

PBT1

PB;T1;;;;;\ Text Area Format Record T1

PE

PE;;;;;\ Multiline Field Paragraph Format Record

PT

PT;;;;;\ ... Multiline Field Paragraph Tab Stop Record

PX

PX;;;;;\ Multiline Field Paragraph Border or Shade Record

T

T;;;;;;\ Dynamic (and Multiline Field) Text Data Record

X

X;;;;;;;;\ ... Dynamic Line\Box Record

Z

Z ;;;;;;;;;;;;\ Signature Record

Z1

Z1;;\ Signature Document Metadata Record

Z2

Z2;;\ Signature Metadata Record

  

Record Format Reference

Image H

H Image Header Record

Syntax

H,units,(paper_size,orientation),(left,top,height,width),name

Parameter

Compiled FAP

Description

Token

CF_START

The "H" header record.

upi

long

The units per inch (UPI). There are 2400 FAP units per inch.

paperSize

long

The paper size: (0=letter, 1=legal).

orientation

long

The form orientation (0=portrait, 1=landscape).

leftMargin

long

The left margin in units per tick mark (UPI).

topMargin

long

The top margin in units per tick mark (UPI).

height

long

The section height in units per tick mark (UPI).

width

long

The section width in units per tick mark (UPI).

name

CF_STR

The section name.

Example

H,2400,(98,0),(600,400,7200,20400),section1

Image H1

A,H1 Image Header Attributes Record

Syntax

A,H1,table_file,tbl_mod,tbl_proc,help_file,hlp_mod,hlp_proc

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,H1" header record.

tblFileName

CF_STR

The default table file name.

tblModName

CF_STR

The user table dynamic module name (the DLL name, excluding the file extension).

tblPrcName

CF_STR

The user table dynamic procedure name.

hlpFileName

CF_STR

The default help file name.

hlpModName

CF_STR

The user help dynamic module name (the DLL name, excluding the file extension).

hlpPrcName

CF_STR

The user help dynamic procedure name.

Example

A,H1,deftable ,tablemod ,tableproc ,defhelp ,helpmod ,help_proc

Image H2

A,H2 Image Header Attributes Record

Syntax

        A,H2,prm,prp,prd

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,H2" header record.

ModName

CF_STR

The pre-edit dynamic module name (the DLL name, excluding the file extension).

PrcName

CF_STR

The pre-edit procedure name.

Data

CF_STR

The pre-edit data.

Example

A,H2,CSTW32,my_pre_proc,123 abc

Image H3

A,H3 Image Header Attributes Record

Syntax

 A,H3,prm,prp,prd

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,H3" header record.

ModName

CF_STR

The post-edit dynamic module name (the DLL name, excluding the file extension).

PrcName

CF_STR

The post-edit procedure name.

Data

CF_STR

The post-edit data.

Example

A,H3,CSTW32,my_post_proc,123 abc

Image H4

A,H4 Image Header Attributes Record

Syntax

A,H4,"designer","update_date","description"

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,H4" header record.

Designer

CF_STR

The designer/user name.

Updated

CF_STR

The update date/time.

Description

CF_STR

The description.

Image H5

A,H5 Image Header Attributes Record

Syntax

A,H5,"send-copy-to",right_margin,bottom_margin

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,H5" header record.

sendCopyTo

CF_STR

The send-copy-to field name.

rightMargin

long

The right margin in units per tick mark (UPI).

bottomMargin

long

The bottom margin in units per tick mark (UPI).

Example

A,H5,"INSURED2",600,400

Image H6

A,H6 Image Header Attributes Record

Syntax

A,H6,versnum,revsnum,"guid","eff_date","eff_time"

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,H6" header record.

versnum

long

The version number.

revsnum

long

The revision number.

glob_unique_id

CF_STR

The global unique ID.

eff_date

CF_STR

The effective date.

eff_time

CF_STR

The effective time.

Example

A,H6,4,3,"01234567890abcdef01234567890abcd","date","time"

Image H7

A,H7 Image Header Attributes Record

Syntax

A,H7,"locale string"

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,H7" header record.

locale

CF_STR

The default ICU locale string for the section. Reserved for future use.

Example

A,H7,"en_US"

Image H8

A,H8Logical Bottom from Normalized fileRecord

Syntax

A,H8,lLogBot,Duplex

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,H8" header record.

lLogBot

long

The logical bottom value.

lDuplex

long

The DJDE duplex value.

Example

A,H8,0,1

Image H9

A,H9Minimum height for dynamic imageRecord

Syntax

A,H9,lMinHeight

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,H9" header record.

lMinHeight

long

The minimum height for the dynamic section.

Example

A,H9,0

Image V

V Image Version Record

Syntax

V,"image_filename","updated_by","update_date","comments"

Parameter

Compiled FAP

Description

Token

CF_REC

The "V" header record.

name

CF_STR

The section's "Save As" file name.

upd_by

CF_STR

The "Updated By" user.

upd_date

CF_STR

The update date/time.

comments

CF_STR

The description.

Example

V,"a ","FORMAKER ","Mon Dec 06 17:04:28 2012 "," "

Barcode B

B Barcode Record

Syntax

B,"nam",(top,lft,bot,rgt),typ,orn,fmt,ht,scl,(fid,fch,fcw,fbl),
(red,grn,blu,opt),eff,len,dat

Parameter

Compiled FAP

Description

Token

CF_REC

The "B" bar code record.

nam

CF_STR

The name. This is optional if the type is zero (0). This is the linked field name if the type is one (1).)

top

long

The top y-coordinate of the rectangle.

lft

long

The left x-coordinate of the rectangle.

bot

long

The bottom y-coordinate of the rectangle.

rgt

long

The right x-coordinate of the rectangle.

typ

long

The data type of  the bar code record:
0 = static text on form
1 = variable data (linked to field record)

orn

long

The orientation: 0 = portrait, 1 = landscape.

fmt

CF_STR

The bar code format type:
A = CODE39 1:1:3:3
B = CODE39 1:1:2:2
... (See the Documaker Studio User Guide for a complete list of bar codes.)
Z = Postal code (delivery point bar code)

ht

long

The height.

scl

long

The scaling factor.

fid

long

The font ID.

fch

long

The font character height.

fcw

long

The font character width.

fbl

long

The font character baseline.

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

eff

long

The effects.

len

long

The length of data.

dat

CF_STR

The data and 0.

Barcode B1

A,B1 Barcode Attributes Record 1

Syntax

A,B1,options,symbolsize

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,B1" field record.

Options

long

Decimal representation of the options for this barcode field. This value is usually set to 0x00000400 (1024), which means the barcode is drawn using a font.

symbolsize

CF_STR

This field is only populated for a Data Matrix barcode. It contains a string representation of the symbolsize for the barcode, e.g. 10x10, 12x12, 12x26.

Example

The record below describes a Data Matrix barcode with a symbolsize of 12x12 that is drawn using a font.

B," ",(4300,1100,4684,1484),0,0,2 ,0,10,(13504,0,0,0),(0,0,0,0),0,5,12345
A,B1,1024,12x12

Box S

S Shaded box Record (no longer used)

Syntax

(See record type X)

Box X

X Box, Shade, Line Record

Syntax

X,(top,lft,bot,rgt),(vth,hth),typ,pat

Parameter

Compiled FAP

Description

Token

CF_REC

The "X" box record.

top

long

The top y-coordinate of the rectangle (in UPI units).

lft

long

The left x-coordinate of the rectangle (in UPI units).

bot

long

The bottom y-coordinate of the rectangle (in UPI units).

rgt

long

The right x-coordinate of the rectangle (in UPI units).

vth

long

The vertical thickness of the line (in UPI units).

hth

long

The horizontal thickness of the line (in UPI units).

typ

long

The type of object:
0,1 = box
2 = shaded line
3 = shaded area
4 = dashed line

pat

long

The type of pattern:
0,13 = solid
1 = horizontal lines
2 = vertical lines
3 = lines slanting right
4 = lines slanting left
5 = vertical crosshatch
6 = slanting crosshatch
7 = shaded (lightest)
...
13 = shaded (darkest)

Example

X,(1924,1615,3882,4192),(14,14),1,0

Chart D

D Chart Record

Syntax

D,"cname",type,(top,left,bottom,right),btype,dlen,slen,bthick,bpat,
fpat,legend, orient,depth,x_angle,y_angle,z_angle

Parameter

Compiled FAP

Description

Token

CF_REC

The "D" Chart begin record.

cname

CF_STR

The name of the chart.

type

long

The type of chart:
1 = 2D pie chart
2 = 2D vertical bar chart
3 = 2D horizontal bar chart
4 = 2D line chart
5 = 2D xy chart
6 = 2D area chart
7 = 2D on-top vertical bar chart
8 = 2D on-top horizontal bar chart
9 = 2D percentage vertical bar chart
10 = 2D percentage horizontal bar chart
11 = 2D percentage area chart
12 = 3D pie chart
13 = 3D vertical bar chart
14 = 3D horizontal bar chart
15 = 3D line chart
16 = 3D area chart
17 = 3D on-top vertical bar chart
18 = 3D on-top horizontal bar chart
19 = 3D percentage vertical bar chart
20 = 3D percentage horizontal bar chart
21 = 3D percentage area chart
22 = 3D split vertical bar chart
23 = 3D split horizontal bar chart
24 = 3D split area chart

top

long

The top y-coordinate of the graphic area.

left

long

The left x-coordinate of the graphic area.

bottom

long

The bottom y-coordinate of the graphic area.

right

long

The right x-coordinate of the graphic area.

btype

long

The boundary type for the graphic area:
2 = solid line
4 = dashed line

dlen

long

The boundary dash length for the graphic area.

slen

long

The boundary space length for thegraphic area.

bthick

long

The boundary thickness for the graphic area.

bpat

long

The boundary pattern for the graphic area. Reserved for future use.

pat

long

The filling pattern for graphic area:
0,13 = solid
1 = horizontal lines
...
14 = no shade

legend

long

Show the legend?

orient

long

The chart orientation.

depth

long

The depth for a 3D chart.

x

long

The 3D viewing angle along x axis.

y

long

The 3D viewing angle along y axis.

z

long

The 3D viewing angle along z axis.

lhgt

long

The legend height.

lwide

long

The legend width.

Example

D,"CHART",1,(2734,3075,9325,9648),2,400,200,20,0,14,1,75,80,0,400,
30.000000,-30.000000,0.000000,0,0

Chart D1

A,D1 Chart Attributes Record 1

Syntax

A,D1,(br,bg,bb,bo),(fr,fg,fb,fo), optn

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,D1" Chart attributes record1.

br

long

The red color index for the graphic area boundary.

bg

long

The green color index for the graphic area boundary.

bb

long

The blue color index for the graphic area boundary.

bo

long

The color option for the graphic area boundary.

fr

long

The red color index for the graphic area filling.

fg

long

The green color index for the graphic area filling.

fb

long

The blue color index for the graphic area filling.

fo

long

The color option for the graphic area filling.

optn

long

The object options (additive values):
0x00000001=does not display or print
0x00000002=does not print, does display
0x00000004=hyphenated text area or paragraph
0x10000000=special full page bitmap

Example

A,D1,(0,0,0,0),(0,0,0,0),512

Chart DA

D,A Chart Series Label Record

Syntax

D,A, (t,l,b,r),btype,dlen,slen,bthick,bpat,fpat,type,font,optn

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,A" Chart series label record.

top

long

The top y-coordinate of label.

left

long

The left x-coordinate of label.

bottom

long

The bottom y-coordinate of label.

right

long

The right x-coordinate of label.

btype

long

The label boundary type (refer to DC).

dlen

long

The label boundary dash length.

slen

long

The label boundary space length.

bthick

long

The label boundary thickness.

bpat

long

The label boundary pattern. Reserved for future use.

fpat

long

The filling pattern label (refer to DC).

type

long

The type of label.

font

long

The font ID for label.

optn

long

The object options (additive values):
0x00000001=does not display or print
0x00000002=does not print, does display
0x00000004=hyphenated text area or paragraph
0x10000000=special full page bitmap

Example

D,A,(0,0,0,0),2,0,0,0,0,14,0,11010,0

Chart DA1

A,DA1 Chart Series Label Attributes Record 1

Syntax

A,DA1,(br,bg,bb,bo),(fr,fg,fb,fo),(lr,lg,lb,lo),orient,effect

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,A1" Chart series label attributes record 1.

br

long

The red color index for the label boundary.

bg

long

The green color index for the label boundary.

bb

long

The blue color index for the label boundary.

bo

CF_STR

The color option for the label boundary.

fr

long

The red color index for the filling label.

fg

long

The green color index for the filling label.

fb

long

The blue color index for the filling label.

fo

CF_STR

The color option for the filling label.

lr

long

The red color index for the label.

lg

long

The green color index for the label.

lb

long

The blue color index for the label.

lo

CF_STR

The color option for the label.

orient

CF_STR

The orientation for the label.

effect

CF_STR

The effects for the label.

Example

A,DA1,(0,0,214,1),(0,0,214,1)(0,0,0,0),0,0,

Chart DB

D,B Chart Custom Data Point Label Record

Syntax

D,B,(top,left,bottom,right),font,len,data

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,B" Chart custom data point label record.

top

long

The top y-coordinate of the chart custom data point label.

left

long

The left x-coordinate of the chart custom data point label.

bottom

long

The bottom y-coordinate of the chart custom data point label.

right

long

The right x-coordinate of the chart custom data point label.

font

long

The font ID.

len

long

The length of label character data.

data

CF_STR

The label character data.

Chart DB1

A,DB1 Chart Custom Data Point Label Attributes Record

Syntax

A,DB1,"fname"

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,DB1" chart custom data point attributes label record 1.

fname

CF_STR

The name of a field.

Chart DC

D,C Chart Area Record

Syntax

D,C,(top,left,bottom,right),btype,dlength,slength,bthick,bpat,fpat

Parameter

Compiled FAP

Description

Token

CF_REC

The ",D" chart area record.

top

long

The top y-coordinate of the chart area.

left

long

The left x-coordinate of the chart area.

bottom

long

The bottom y-coordinate of the chart area.

right

long

The right x-coordinate of the chart area.

btype

long

The boundary type for the chart area:
2 = solid line
4 = dashed line

dlen

long

The boundary dash length type for the chart area.

slen

long

The boundary space length type for the chart area.

bthick

long

The boundary thickness type for the chart area.

bpat

long

The boundary pattern type for the chart area. Reserved for future use.

fpat

long

The filling pattern type for the chart area:
0,13 = solid
1 = horizontal lines
2 = vertical lines
3 = lines slanting right
4 = lines slanting left
5 = vertical crosshatch
6 = slanting crosshatch
7 = shaded (lightest)
.....
13 = shaded (darkest)

Example

D,C,(4197,3024,5673,4285),2,400,200,20,0,9

Chart DC1

A,DC1 Chart Area Attributes Record 1

Syntax

A,DC1,(br,bg,bb,bo),(fr,fg,fb,fo)

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,DC1" chart area attributes record 1.

br

long

The red color index for boundary.

bg

long

The green color index for boundary.

bb

long

The blue color index for boundary.

bo

long

The color option for boundary.

fr

long

The red color index for filling.

fg

long

The green color index for filling.

fb

long

The blue color index for filling.

fo

long

The color option for filling.

Example

A,DC1,(0,255,255,3),(0,255,255,3)

Chart DD

D,D Chart Data Record

Syntax

D,D,"sname","fname",data

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,D" chart data record.

sname

CF_STR

The name of the series (a character string).

fname

CF_STR

The name of a field.

data

double

The series data (a numerical value).

Example

D,D,"Series 1","FIELD",10.000000

Chart DE

D,E Chart Scale-Axis Record

Syntax

D,E,max,min,munit,tunit,type,dlen,slen,thick,pat,tick,minor,
dtext,(top,left,bottom,right),d_font

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,E" chart scale-axis record.

max

long

The maximum value of the X axis.

min

long

The minimum value of the X axis.

munit

long

The unit per minor axis.

tunit

long

The unit per tick.

type

long

The axis line type (refer to DC).

dlen

long

The axis dash length.

slen

long

The axis space length.

thick

long

The axis thickness.

pat

long

The axis pattern.

tick

long

Show tick.

minor

long

Show minor axes.

dtext

long

Show data text.

top

long

The top y-coordinate of data text.

left

long

The left x-coordinate of data text.

bottom

long

The bottom y-coordinate of data text.

right

long

The right x-coordinate of data text.

d

long

The font ID for data text.

Example

D,E,50.000000,0.000000,10.000000,2.000000,2,0,0,20,0,1,1,1,
(0,0,0,0),11010

Chart DE1

A,DE1 Chart Scale-Axis Attributes Record 1

Syntax

A,DE1,(r,g,b,o),(dr,dg,db,do),d_orient,d_effect

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,DE1" Chart Scale-Axis attributes record 1.

r

long

The red color index for x axis.

g

long

The green color index for x axis.

b

long

The blue color index for x axis.

o

long

The color option for x axis.

dr

long

The red color index for data text.

dg

long

The green color index for data text.

db

long

The blue color index for data text.

dopt

long

The color option for data text.

d_or

long

The orientation for data text.

d_ef

long

The effects for data text.

Chart DE2

A,DE2 Chart Scale-Axis Attributes Record 2

Syntax

A,DE2,minname,maxname,incname,tmname

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,DE2" Chart Scale-Axis attributes record 2.

minname

CF_STR

The field name for minimum scale axis.

maxname

CF_STR

The field name for maximum scale axis.

incname

CF_STR

The field name for increment scale axis.

tmname

CF_STR

The field name for unit scale axis.

Chart DK

A,DK Chart Linking Attributes Record 1

Syntax

A,DK,rfu,Chart

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,K" Chart legend attributes record.

rfu

long

Reserved for future use.

chart

CF_STR

The name of a chart to link with.

Chart DL

D,L Chart Legend Record

Syntax

D,L,(top,left,bottom,right),btype,dlen,slen,bthick,bpat,fpat

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,L" Chart legend record.

top

long

The top y-coordinate of chart legend.

left

long

The left x-coordinate of chart legend.

bottom

long

The bottom y-coordinate of chart legend.

right

long

The right x-coordinate of chart legend.

btype

long

The boundary type (refer to DC).

dlen

long

The boundary dash length.

slen

long

The boundary space length.

bthick

long

The boundary thickness.

bpat

long

The boundary pattern.

fpat

long

The filling pattern (refer to DC).

fid

long

The font ID.

fht

long

The font height.

fwd

long

The font width.

fbl

long

The font baseline height.

Example

D,L,(3969,5351,6913,7241),2,400,200,20,0,14,0,0,0,0

Chart DL1

A,DL1 Chart Legend Attributes Record 1

Syntax

A,DL1,(br,bg,bb,bo),(fr,fg,fb,fo)

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,L" Chart legend attributes record.

br

long

The red color index for boundary.

bg

long

The green color index for boundary.

bb

long

The blue color index for boundary.

bo

long

The color option for boundary.

fr

long

The red color index for filling.

fg

long

The green color index for filling.

fb

long

The blue color index for filling.

fo

long

The color option for filling.

Chart DP

D,P Chart Point-Axis Record

Syntax

D,P,max,min,munit,tunit,type,dlen,slen,thick,pat,tick,minor,
dtext,(top,left,bottom,right),d_font

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,E" Chart point-axis record.

max

long

The maximum value of the y axis.

min

long

The minimum value of the y axis.

munit

long

The unit per minor axis.

tunit

long

The unit per tick.

type

long

The axis line type (refer to DC).

dlen

long

The axis dash length.

slen

long

The axis space length.

thick

long

The axis thickness.

pat

long

The axis pattern.

tick

long

Show tick.

minor

long

Show minor axes.

dtext

long

Show data text.

top

long

The top y-coordinate of data text.

left

long

The left x-coordinate of data text.

bottom

long

The bottom y-coordinate of data text.

right

long

The right x-coordinate of data text.

d

long

The font ID for data text.

Example

D,P,12.000000,1.000000,1.000000,0.000000,2,0,0,20,0,1,1,1,
(0,0,0,0),11010

Chart DP1

A,DP1 Chart Point-Axis Attributes Record 1

Syntax

A,DP1,(r,g,b,o),(dr,dg,db,do),d_orient,d_effect

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,DE1" Chart scale-axis attributes record 1.

r

long

The red color index for x axis.

g

long

The green color index for x axis.

b

long

The blue color index for x axis.

o

long

The color option for x axis.

dr

long

The red color index for data text.

dg

long

The green color index for data text.

db

long

The blue color index for data text.

dopt

long

The color option for data text.

d_or

long

The orientation for data text.

d_ef

long

The effects for data text.

Chart DS

D,S Chart Series Record

Syntax

D,S,"sname",n_font,btype,dlen,slen,bthick,bpat,fpat,marker,msize,exp,fn
(Followed by a DA and a group of DD's)

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,S" Chart series record.

sname

CF_STR

The name of the series (a character string).

n

long

The font ID for this series name.

btype

long

The boundary type for this series (refer to DC).

dlen

long

The boundary dash length for this series.

slen

long

The boundary space length for this series.

bthick

long

The boundary thickness for this series.

bpat

long

The boundary pattern for this series. Reserved for future use.

fpat

long

The filling pattern type for this series (refer to DC).

marker

long

The marker type for this series:
1 = +
2 = X
3 = combination of + and X
4 = *
5 = diamond
6 = square
7 = up triangle
8 = down triangle
9 = circle
10 = filled diamond
11 = filled square
12 = filled up triangle
13 = filled down triangle
14 = filled circle
15 = + in diamond
16 = + in square
17 = + in circle
18 = + and X in diamond
19 = + and X in square
20 = + and X in circle
21 = vertical bar in diamond
22 = vertical bar in square
23 = vertical bar in circle
24 = horizontal bar in diamond
25 = horizontal bar in square
26 = horizontal bar in circle
27 = dot in diamond
28 = dot in square
29 = dot in circle
30 = vertical bar
31 = horizontal bar

msize

long

The marker size for this series (% of the default size).

exp

long

The explode % (% of radius).

fnam

CF_STR


Example

D,S,"Series 1",11010,2,300,150,20,0,0,1,50,20,""

Chart DS1

A,DS1 Chart Series Attributes Record 1

Syntax

A,DS1,(nr,ng,nb,no),n_orient,n_effect,(br,bg,bb,bo),(fr,fg,fb,fo)

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,S" Chart series attributes record 1.

nr

long

The red color index for series name.

ng

long

The green color index series name.

nb

long

The blue color index for series name.

no

long

The color option for series name.

n_or

long

The orientation for series name.

n_ef

long

The effects for series name.

br

long

The red color index for boundary.

bg

long

The green color index for boundary.

bb

long

The blue color index for boundary.

bo

long

The color option for boundary.

fr

long

The red color index for filling.

fg

long

The green color index for filling.

fb

long

The blue color index for filling.

fo

long

The color option for filling.

Example

A,DS1,(0,0,0,0),0,0,(0,0,214,1),(0,0,214,1)

Chart DT

D,T Chart Title Record

Syntax

D,T,(top,left,bottom,right),font,len,data

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,T" Chart title record.

top

long

The top y-coordinate of title.

left

long

The left x-coordinate of title.

bottom

long

The bottom y-coordinate of title.

right

long

The right x-coordinate of title.

font

long

The font ID.

len

long

The length of title character data.

data

CF_STR

The title character data.

Example

D,T,(7920,6913,8224,7337),11010,3,Pie Chart

Chart DT1

A,DT1 Chart Title Attributes Record 1

Syntax

A,DT1,(r,g,b,o),orient,effect

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,DT1" Chart title attributes record.

r

long

The red color index for title.

g

long

The green color index for title.

b

long

The blue color index for title.

o

long

The color option for title.

orient

long

The orientation.

effect

long

The effects.

Example

A,DT1,(255,0,0,1),90,5

Chart DX

D,X Chart X-Axis Record (no longer used)

Syntax

D,X,max,min,munit,tunit,type,dlen,slen,thick,pat,tick,minor,
dtext,(top,left,bottom,right),d_font
(followed by DT)

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,X" chart X-axis record. This record type is no longer used. The "D,P" point axis and "D,E" scale axis records do this now.

max

long

The maximum value of the x axis.

min

long

The minimum value of the x axis.

munit

long

The unit per minor axis.

tunit

long

The unit per tick.

type

long

The axis line type (refer to DC).

dlen

long

The axis dash length.

slen

long

The axis space length.

thick

long

The axis thickness.

pat

long

The axis pattern.

tick

long

Show tick.

minor

long

Show minor axes.

dtext

long

Show data text.

top

long

The top y-coordinate of data text.

left

long

The left x-coordinate of data text.

bottom

long

The bottom y-coordinate of data text.

right

long

The right x-coordinate of data text.

d

long

The font ID for data text.

Chart DX1

A,DX1 Chart X-Axis Attributes Record 1 (no longer used)

Syntax

A,DX1,(r,g,b,o),(dr,dg,db,do),d_orient,d_effect

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,DX1" Chart x-axis attributes record 1. This record type is no longer used. The "D,P" point axis and "D,E" scale axis records do this now.

r

long

The red color index for x axis.

g

long

The green color index for x axis.

b

long

The blue color index for x axis.

o

long

The color option for x axis.

dr

long

The red color index for data text.

dg

long

The green color index for data text.

db

long

The blue color index for data text.

dopt

long

The color option for data text.

d_or

long

The orientation for data text.

d_ef

long

The effects for data text.

Chart DY

D,Y Chart Y-Axis Record (no longer used)

Syntax

D,Y,max,min,munit,tunit,type,dlen,slen,thick,pat,tick,minor,
dtext,(top,left,bottom,right),d_font
(followed by DT)

Parameter

Compiled FAP

Description

Token

CF_REC

The "D,Y" Chart y-axis record. This record type is no longer used. The "D,P" point axis and "D,E" scale axis records do this now.

max

long

The maximum value of the y axis.

min

long

The minimum value of the y axis.

munit

long

The unit per minor axis.

tunit

long

The unit per tick.

type

long

The axis line type (refer to DC).

dlen

long

The axis dash length.

slen

long

The axis space length.

thick

long

The axis thickness.

pat

long

The axis pattern.

tick

long

Show tick.

minor

long

Show the minor axes.

dtext

long

Show the data text.

top

long

The top y-coordinate of the data text.

left

long

The left x-coordinate of the data text.

bottom

long

The bottom y-coordinate of the data text.

right

long

The right x-coordinate of the data text.

d

long

The font ID for the data text.

Chart DY1

A,DY1 Chart Y-Axis Attributes Record 1 (no longer used)

Syntax

A,DY1,(r,g,b,o),(dr,dg,db,do),d_orient,d_effect

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,DY1" Chart y-axis attributes record 1. This record type is no longer used. The "D,P" point axis and "D,E" scale axis records do this now.

r

long

The red color index for x axis.

g

long

The green color index for x axis.

b

long

The blue color index for x axis.

o

long

The color option for x axis.

dr

long

The red color index for data text.

dg

long

The green color index for data text.

db

long

The blue color index for data text.

dopt

long

The color option for data text.

d_or

long

The orientation for data text.

d_ef

long

The effects for data text.

Color C

C Color Record

Syntax

C,"cnm",typ,sbt,(red,grn,blu,opt),flg,opn

Parameter

Compiled FAP

Description

Token

CF_REC

The "C" color record.

cnm

CF_STR

The name.

typ

long

The type of object:
6 = section background
7 = lines/boxes/shades
8 = bitmaps
9 = merged text
10 = static text
11 = fields
12 = bar code

sbt

long

The subtype (not used-- always zero).

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

flg

long

The options flag. Reserved for future use.

opn

long

The other options. Reserved for future use.

Example

C," ",4,0,(0,255,255,1),0,0

Field F

F Field Record

Syntax

F,(top,lft,bot,rgt),(fid,fch,fcw,fbl),len,vfn

Parameter

Compiled FAP

Description

Token

CF_REC

The "F" field record.

top

long

The top y-coordinate of the rectangle in units per tick mark (UPI).

lft

long

The left x-coordinate of the rectangle in units per tick mark (UPI).

bot

long

The bottom y-coordinate of the rectangle in units per tick mark (UPI).

rgt

long

The right x-coordinate of the rectangle in units per tick mark (UPI).

fid

long

The font ID (see record type R).

fch

long

The font character height (see record type R).

fcw

long

The font character width (see record type R).

fbl

long

The font character baseline (see record type R).

len

long

The length of variable field (number of characters).

vfn

CF_STR

The variable field name.

Example

F,(3972,24187,4236,24387),(57,333,400,264),22,TESTFIELD

Field F1

A,F1 Field Attributes Record 1

Syntax

A,F1,"fnm",ft,"ff",lgf,dof,req,(red,grn,blu,opt),eff,orn,fp

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,F1" field record.

fnm

CF_STR

The field name, omitted—use previous field record (record type F).

ft

CF_STR

The field type, case sensitive, for instance:
C = custom
x = alphanumeric
k = international alphanumeric
a = alphabetic
i = international alphabetic
X = uppercase alphanumeric
K = international uppercase alphanumeric
A = uppercase alphabetic
I = international uppercase alphabetic
n = numeric
y = y/n - y(yes) or n(no)
m = x or space
d = date format
t = time
M = multiline text (linked to multiline text region)
B = bar code (linked to bar code record)
CF_STR ff, /*field format (see the Documaker Workstation User Guide)

lgf

long

The local/global flag (scope of field name):
0 = local to section
1 = reserved
2 = global to form (sections within form)
3 = global to form set (all active forms and sections)

dof

long

The display-only flag:
0 = display and update
1 = display only

req

long

The required flag:
0 = optional (may be handled in edit procedures)
1 = required (entry required)

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

eff

long

The effects:
0 = no special effects
1 = underline
2 = strike-out
3 = underline and strike-out

orn

long

The orientation (rotation):
0 = normal
90 = downward
180 = upside down
270 = upward

fp

CF_STR

The field prompt text.

Example

A,F1," ",x ," ",3,0,0,(255,0,0,0),0,0,Field Prompt

Field F2

A,F2 Field Attributes Record 2

Syntax

A,F2,"fnm",hpt,hfn,"hpn",tbt,tfn,tbn,tbr,"bgf","nbf",gin,gds

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,F2" field record.

fnm

CF_STR

The field name: omitted—use the previous field record (record type F)

hpt

long

The help type: 0=built-in, 1=user.

hfn

CF_STR

(Optional) The help file name. If blank, use the section help file name.

hpn

CF_STR

The help name.

tbt

long

The table type: 0=built-in, 1=user.

tfn

CF_STR

(Optional) The table file name. If blank, use the section table file name.

tbn

CF_STR

The table name.

tbr

CF_STR

The table return:
K = key
D = description K+D = key and description
D+K = description and key
empty = nothing

bgf

CF_STR

The blank goto field name.

nbf

CF_STR

The non-blank goto field name.

gin

long

The group indicator:
0 = does not begin a new field group
1 = begins a new field group

gds

CF_STR

The group description text.

Example

A,F2," ",0,fldhelp ,"hlpid ",0,fldtable ,tblid ,K+D ,"blarg1 ",
"blarg2 ",1,section description

Field F3

A,F3 Field Attributes Record 3

Syntax

A,F3,"fnm",prm,prp,prd

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,F3" field record.

fnm

CF_STR

The field name: omitted—use previous field record (record type F).

prm

CF_STR

The pre-edit dynamic module name (no extension).

prp

CF_STR

The pre-edit dynamic procedure name.

prd

CF_STR

The pre-edit data.

Example

A,F3," ",premodule ,preproc ,pre data

Field F4

A,F4 Field Attributes Record 4

Syntax

A,F4,"fnm",pom,pop,pod

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,F4" field record.

fnm

CF_STR

The field name: omitted—use previous field record (record type F).

pom

CF_STR

The post-edit dynamic module name (no extension).

pop

CF_STR

The post-edit dynamic procedure name.

pod

CF_STR

The post-edit data.

Example

A,F4," ",postmodule ,psotproc ,post data

Field F5

A,F5 Field Attributes Record 5

Syntax

A,F5,"fnm",clc

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,F5" field record.

F5

CF_STR

The subtype (Field attributes record 5).

fnm

CF_STR

The field name: omitted—use previous field record (record type F).

clc

CF_STR

The field calc text.

Example

A,F5," ",dal calc here

Field F6

A,F6 Field Attributes Record 6

Syntax

A,F6,"fnm",sct,scl,dmy,calc,fmt,"link",spct,spc,tab,tmar,bmar, lind,
rind,hind,flg,popt,plang,fopt,flang,"loc",baseline adj

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,F6" field record.

F6

long

The subtype (Field attributes record 6).

fnm

CF_STR

The field name: omitted—use previous field record (record type F).

sct

long

The send copy to flag:
0 - not a a "send copy to" field
1 - a "send copy to" field

scl

long

The scaling factor for bar code type.

dmy

long

The dummy field flag.

calc

long

The calc type.

fmt

long

The format type for multiline text.

link

CF_STR

The link name.

spct

long

The spacing type.

spc

long

The spacing.

tab

long

The tab stop.

tmar

long

The top margin.

bmar

long

The bottom margin.

lind

long

The left indent.

rind

long

The right indent.

hind

long

The hanging indent.

flg

long


popt

long

The paragraph options.

plang

long

The paragraph language for hyphenation.

fopt

long

The field options.

flanguage

long

The field language.

loc

CF_STR

The locale.

baselineAdj

long

The adjustment for subscript.

Example

A,F6," ",0,1,1,0,0," ",0,0,600,0,0,0,0,0,0,0,0,0,0,0,0,0,0,"en_US",0

Field F7

A,F7 Field Attributes Record 7

Syntax

A,F7,"fnm",bpsdAlign,bpsdEndChar,bpsdLines,bpsdReplaceChar,
vsdPointSize,bpsdDeleteChar

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,F7" field record.

F7

CF_STR

The subtype (Field attributes record 7).

fnm

CF_STR

The field name: omitted—use previous field record (record type F).

bpsdAlign

long

The code point for Y/N (decimal), Documerge tag info.

bpsdEndChar

long

The end char code point, Documerge tag info.

bpsdLines

long

The number of lines for BPSD, Documerge tag info.

bpsdReplaceChar

long

The replacement char code point, Documerge tag info.

vsdPointSize

long

The vsd point size, Documerge tag info.

bpsdDeleteChar

long

The Documerge tag for Delete= Y/N/1/R.

Example

A,F7," ",89,162,0,33,0,89

Field F8

A,F8 Field Attributes Record 8

Syntax

A,F8,SrcOvfl,flg1,flg2,flg3,flg4,;FmtMask;,RuleName,SrcFieldName,SrcType,;SrcFormat;,
DestLen,DestOffset, TblNdx, SrcLen, SrcOffset, SrcRec, RuleParmsLen,
SrcMult, RuleParms

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,F8" field record.

F8

CF_STR

The subtype (field attributes record 8).

SrcOvfl

CF_STR

Source Overflow setting
Form =GETFORM
Form set (Section) = GETFORMSETIMAGE
None = None
Section = GETIMAGE
Default = " "

fnm

CF_STR

The field name: omitted—use previous field record (record type F).

Flag1

CF_STR

Not Required Y or N

Flag2

CF_STR

Host Required Y or N

Flag3

CF_STR

Operator Required Y or N

Flag4

CF_STR

Optional Required Y or N

FmtMask

CF_STR

The rule format mask.

RuleName

CF_STR

The rule name.

SrcFieldName

CF_STR

The source field name.

SrcType

CF_STR

The source field type.

SrcFormat

CF_STR

source field format.

DestLen

long

The destination length.

DestOffset

long

The destination offset.

TblNdx

long

The index of the table name.

SrcLen

long

The source length.

SrcOffset

long

The source offset.

SrcRec

long

The source record.

RuleParmsLen

long

The length of the rule data.

SrcMult

long

The source multiplier.

RuleParms

CF_STR

The rule parameter data.

Example

A,F8,"",N,N,N,N,;this is my mask;,"ANYTOANY","datediff rule/#1359557977","",;;,19,25,15,100,30,125,15,200\this is my data 

Field F9

A,F9 Field Attributes Record 9

Syntax

A,F9,"name",type,options,parmslen,parms,hreflen,href

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,F9" field record.

F9

CF_STR

The subtype (Field attributes record 9).

Name

CF_STR

The link name.

Type

long

The  type: 1=target, 2=href, 4=hot.

Options

long

The PDF link style, 0=None, 1=Solid, 2=Dash, 3=Underline.

ParamsLen

long

The length of the params string.

Params

CF_STR

The HREF parameters used by HTML.

HrefLen

long

The length of the HREF string.

hrefData

CF_STR

The HREF data.

Field FB

A,FB Field Attributes Record FB

Syntax

A,FB,options,symbolsize

Parameter                               

Compiled FAP                               

Description                               

Token

CF_REC

The "A,FB" field record.

Options

long

Decimal representation of the options for this barcode field. This value is usually set to 0x00000400 (1024), which means the barcode is drawn using a font.

Symbolsize

CF_STR

This field is only populated for a Data Matrix barcode. It contains a string representation of the symbolsize for the barcode, e.g. 10x10, 12x12, 12x26.

Example

The record below describes a Data Matrix barcode with a symbolsize of 10x10 that is drawn using a font.

F,(2650,1475,3778,5155),(24010,376,368,312),20,Data Matrix 10x10
A,F1," ",B ,"2 ",0,0,0,(255,0,0,0),0,0,
A,F6," ",0,10,0,0,64," ",0,0,0,0,0,0,0,0,0,0,0,128,0," ",0
A,F7," ",0,0,0,64,0,0
A,F8,"",N,N,N,N,;my mask;,"MOVEBARCODE","my source name","",;;,20,0,0,0,0,0,7,0\my data
A,FB,1024,10x10

Field FC

A,FC Field Attributes Record FC

Syntax

A,FC,lindent,rindent,hindent

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,FC" field record.

lindent

long

The left indent in FAP units.

rindent

long

The right indent in FAP units.

hindent

long

The hanging indent in FAP units.

Font R

R Font Record

Syntax

R,fid,fch,fcw,fbl,fntn,fonn

Parameter

Compiled FAP

Description

Token

CF_REC

The "R" font record.

fid

long

The system global font ID.

fch

long

The font character height in units per tick mark (UPI).

fcw

long

The font character width in units per tick mark (UPI).

fbl

long

The font character base line in units per tick mark (UPI).

fntn

CF_STR

The font file name (*1).

fonn

CF_STR

The font width table file name (*2).

Notes

(*1) in the FormMaker DOS environment, this file name has the extension .FNT.

(*2) in the FormMaker DOS environment, this file name has the extension .FON.

Font R1

A,R1 Font Attributes Record 1

Syntax

A,R1,fid,ps,orn,spc,sty,wt,"fam","fac",dsc

Parameter

Compiled FAP

Description

A

CF_REC

The "A,R1" header record.

fid

long

The global system font ID, 0=supplies attributes to preceding font record (record type R).

ps

long

The point size in 100ths, 1000 = 10.00 pt size, if < 100, then whole pt size (10, 12, and so on).

orn

long

The orientation, 0= portrait, 1=landscape.

spc

long

The spacing (or type size), 0=fixed, 1=proportional.

sty

long

The style code.

wt

long

The stroke weight.

fam

CF_STR

The typeface family name.

fac

CF_STR

The typeface name.

dsc

CF_STR

The description (for the Font Selection window).

Font R2

A,R2 Font Attributes Record 2 Syntax A,R2,fid,cgr,cw1,cw2,cw3,...,cw32

Syntax

Parameter

Compiled FAP

Description

A

CF_REC

The "A,R2" header record.

fid

long

The font ID: 0=use previous font record (record type R, or A-R1, or A-R2).

cgr

long

The character group record number (1 through 8), each character group consists of 32 characters: group record 1 contains characters 0 through 31, group record 2 contains characters 32 through 63, and so on..

cw

long

The width (FAP units) of first through thirty-second characters in group.

Notes

Most fonts only need to supply R2 records for character group records 2, 3, and 4 (characters 32 through 127) since most fonts do not supply widths for the other characters.

Font R3

A,R3 Font Attributes Record 3

Syntax

A,R3,fid,pt,flg,opt,idx,"ffn","tfc","cid","csn","dat",sup

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,R3" header record (one record per printer type).

fid

long

The font ID, 0=use previous font record (record type R, or A-R1, or A-R2).

pt

CF_STR

The printer type:
PCL = HP PCL printers
AFP = IBM AFP printers
XMC = Xerox Metacode printers
PS = Postscript printers
OTH = Other printer type

flg

long

The flag.

opt

long

The options.

idx

long

The index.

ffn

CF_STR

The font file name.

tfc

CF_STR

The typeface code.

cid

CF_STR

The character set ID.

csn

CF_STR

The character set name.

dat

CF_STR

Miscellaneous data.

sup

CF_STR

The font printer setup data.

Font R4

A,R4 Font Attributes Record 4

Syntax

A,R4,fid,cdpg,intlead,extlead,lcascent,ucascent,unicodeID

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,R4" header record

fid

long

The font ID: 0=use previous font record (record type R, or A-R1, or A-R2).

cdpg

long

The code page, legacy for OS/2 display.

intlead

long

The internalLeading, used for PFMs.

extlead

long

The externalLeading, used for PFMs.

lcascent

long

The lowerCaseAscent, used for PFMs.

ucascent

long

The lowerCaseDescent, used for PFMs.

unicodeID

long

The Unicode font ID. Reserved for future use.

Font R5

A,R5 Font Attributes Record 5

Syntax

A,R5,fid,vn,rv,"guid","ef_dt","ef_tm"

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,R5" header record (version information).

fid

long

The font ID: 0=use previous font record (record type R, or A-R1, or A-R2).

vn

long

The version number.

rn

long

The revision number.

guid

CF_STR

The global unique ID.

ef_dt

CF_STR

The effective date.

ef_tm

CF_STR

The effective time.

Font R6

A,R5 Font Attributes Record 6

Syntax

A,R6,fid,start,end,deltaID,cw1,cw2,cw3,...

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,R6" header record.

fid

long

The font ID, 0=use previous font record (record type R, or A-R1, or A-R2).

start

long

The starting Unicode code point (hex).

end

long

The ending Unicode code point (hex).

deltaID

long

The delta to calculate the glyph ID (hex).

cw

long

The character widths in FAP units for the Unicode code points (start to end).

Graphic G

G Graphic/logo Record

Syntax

G,(top,lft,bot,rgt),bmn

Parameter

Compiled FAP

Description

Token

CF_REC

The "G" graphic/logo record.

top

long

The top y-coordinate of the rectangle (in UPI units).

lft

long

The left x-coordinate of the rectangle (in UPI units).

bot

long

The bottom y-coordinate of the rectangle (in UPI units).

rgt

long

The right x-coordinate of the rectangle (in UPI units).

bmn

CF_STR

The bitmap file name.

Graphics BEGLOGO

\BEGLOGO\Graphic/logo Attributes

Syntax

\BEGLOGO\

Parameter

Compiled FAP

Description

Token

CF_STR

The "\BEGLOGO\" graphic/logo record follows the "A,G1" record for an inlined logo.

Graphics ENDLOGO

\ENDLOGO\Graphic/logo Attributes

Syntax

\ENDLOGO\

Parameter

Compiled FAP

Description

Token

CF_STR

The "\ENDLOGO\" graphic/logo record follows the last "A,G5" record for an inlined logo.

Graphics G1

A,G1 Graphic/logo Attributes Record 1

Syntax

A,G1,typ,res,(red,grn,blu,opt),orn,sty,"nam" inline, optn

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,G" graphic/logo record.

typ

long

The graphics type:
1 = Documaker LOG file (bitmap)

res

long

The resolution of bitmap in DPI.

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

orn

long

The orientation (rotation):
0 = normal
90 = downward
180 = upside down
270 = upward

sty

long

The style:
0 = normal
1 = protected (signature)

nam

CF_STR

(Optional) The Metacode bitmap font name.

inline

long

The in-line bitmap flag.

optn

long

The object options (additive values):
0x00000001=does not display or print
0x00000002=does not print, does display
0x00000004=hyphenated text area or paragraph
0x10000000=special full page bitmap

Graphics G2

A,G2 Graphic/logo Attributes Record 2

Syntax

A,G2,rows,wide,byteWide,res,bitsper,cmp,nm0,nm90,nm180,nm270,colors

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,G2" graphic/logo record.

rows

long

The rows.

wide

long

The width.

byteWide

long

The byte width.

res

long

The resolution of bitmap in DPI.

bitsper

long

The bits per pixel.

cmp

long

The compression type.

nm0

CF_STR

The name, when rotated zero (0) degrees.

nm90

CF_STR

The name, when rotated 90 degrees.

nm180

CF_STR

The name, when rotated 180 degrees.

nm270

CF_STR

The name, when rotated 270 degrees.

colors

long

The colors used.

Example

A,G2,0264,0450,1350,299,24,5," "," "," "," ",0

Graphics G3

A,G3 Graphic/logo Attributes Record 3

Syntax

A,G3,rgbBlue,rgbGreen,rgbRed

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,G3" graphic/logo record.

rgbBlue

long

The color palette.

rgbGreen

long

The color palette.

rgbRed

long

The color palette.

Example

A,G3,128,0,0

Graphics G4

A,G4 Graphic/logo Attributes Record 4

Syntax

A,G4,type,rows,cols,size

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,G4" graphic/logo record.

type

long

The bitmap type.

rows

long

The rows.

cols

long

The columns.

size

long

The size.

Example

A,G4,5,264,1352,26044

Graphics G5

A,G5 graphic/logo Attributes Record 5

Syntax

A,G5,data

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,G5" graphic/logo record.

data

CF_STR

The row of bitmap data.

Example

A,G5,0U9pjchjkv3OKXadB0nbkP0CnKihmWqHJpFPJU91o...

Graphics G6

A,G6 graphic/logo Attributes Record 6

Syntax

A,G6,versnum,revsnum,"guid","eff_date","eff_time"

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,G6" graphic/logo record.

versnum

long

The version number.

revsnum

long

The revision number.

glob_unique_id

CF_STR

The global unique ID.

eff_date

CF_STR

The effective date.

eff_time

CF_STR

The effective time.

Example

A,G6,4,3,"01234567890abcdef01234567890abcd","date","time"

Graphics G7

A,G7 Graphic/logo Attributes Record 7

Syntax

A,G7,"name",type,options,parmslen,parms,hreflen,href

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,G7" graphic/logo record.

G7

CF_STR

The subtype (Logo attribute record 7).

Name

CF_STR

The link name.

Type

long

The link type: 1=target, 2=href, 4=hot.

Options

long

The PDF link style: 0=None, 1=Solid, 2=Dash, 3=Underline.

ParamsLen

long

The length of the params string.

Params

CF_STR

The HREF parameters used in the HTML.

HrefLen

long

The length of the HREF string.

hrefData

CF_STR

The HREF data.

Example

A,G7,"gotofield",4,0,0,,0,

Guideline L

L Guideline Record

Syntax

L,(top,lft,bot,rgt),typ,opt

Parameter

Compiled FAP

Description

Token

CF_REC

The "L" guideline record.

top

long

The top y-coordinate of the rectangle (in UPI units).

lft

long

The left x-coordinate of the rectangle (in UPI units).

bot

long

The bottom y-coordinate of the rectangle (in UPI units).

rgt

long

The right x-coordinate of the rectangle (in UPI units).

typ

long

The type. Reserved for future use.

opt

long

The options.

Example

L,(5118,15375,6118,16575),0,164

Guideline L1

A,L1 Guideline Attributes Record 1

Syntax

A,L1,(red,grn,blu,opt),"nam", optn

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,L1" guideline attributes record.

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

nam

CF_STR

(Optional) The guideline name.

optn

long

The object options (additive values):
0x00000001=does not display or print
0x00000002=does not print, does display
0x00000004=hyphenated text area or paragraph
0x10000000=special full page bitmap

Example

A,L1,(192,192,192,0),"Guide ",164

ImageRule J

L Image Rule Record

Syntax

J,rulename,\ruledata

Parameter

Compiled FAP

Description

Token

CF_REC

The "J" section rule record.

rulename

size_t szString

The section rule name.

ruledata

size_t szString

The section rule data.

Example

J,SETORIGIN,\Rel+0, Max+0

Line X1

A,X1 Box, Shade, Line Attributes Record 1

Syntax

A,X1,"lbn",orn,(red,grn,blu,opt),eff,optn

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,X1" line record.

lbn

CF_STR

(Optional) The line/box name.

gap

long

The space from text for borders.

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

eff

long

The effects.

optn

long

The object options (additive values):
0x00000001=does not display or print
0x00000002=does not print, does display
0x00000004=hyphenated text area or paragraph
0x10000000=special full page bitmap

Example

A,X1,"Test ",0,(0,0,128,1),0,0

Line X2

A,X2 Box, Shade, Line Attributes Record 2

Syntax

A,X2,lc,tbw,lbw,bbw,rbw,tbg,lbg,bbg,rbg,tbs,lbs,bbs,rgs

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,X2" line record.

lc

long

The line count, DCD paragraph border.

tbw

long

The top box width, DCD paragraph border.

lbw

long

The left box width, DCD paragraph border.

bbw

long

The bottom box width, DCD paragraph border.

rbw

long

The right box width, DCD paragraph border.

tbg

long

The top box gap, DCD paragraph border.

lbg

long

The left box gap, DCD paragraph border.

bbg

long

The bottom box gap, DCD paragraph border.

rbg

long

The right box gap, DCD paragraph border.

tbs

long

The top box style, DCD paragraph border.

lbs

long

The left box style, DCD paragraph border.

bbs

long

The bottom box style, DCD paragraph border.

rbs

long

The right box style, DCD paragraph border.

Example

A,X2,1,1,1,1,1,1,1,1,1,1,1,1,1

Line X3

A,X3 Border Flags Record 3

Syntax

A,X3,bdrFlags

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,X3" line record.

bdrFlags

long

The border flags.

Example

A,X3,63

Note N

N Note Record

Syntax

N,(top,lft,bot,rgt),typ,sty,len,txt

Parameter

Compiled FAP

Description

Token

CF_REC

The "N" note record.

top

long

The top y-coordinate of the rectangle (in UPI units).

lft

long

The left x-coordinate of the rectangle (in UPI units).

bot

long

The bottom y-coordinate of the rectangle (in UPI units).

rgt

long

The right x-coordinate of the rectangle (in UPI units).

typ

long

The type:
0 - standard note
3 - table of contents
4 - index table
8 - figures table
16 - citation table
other values reserved

sty

long

The style:
1 - sticky pad
2 - memo
3 - table of contents
4 - index table
8 - figures table
16 - citation table
The values 3 and greater may be combined to define the types of bookmarks defined. The note type will be zero (0) in the case of bookmarks.

len

long

The note text length.

txt

CF_STR

The note text.

Example

N,(5318,15188,6118,15988),0,2,4,Text

Note N1

A,N1 Note Attributes Record 1

Syntax

A,N1,(red,grn,blu,opt),"nam","dte","rcv","snd","sbj",optn,level

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,N1" note attributes record.

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

nam

CF_STR

(Optional) The note name.

dte

CF_STR

(Optional) The date (style dependant).

rcv

CF_STR

(Optional) The receiver of note (style dependant).

snd

CF_STR

(Optional) The sender of note (style dependant).

sbj

CF_STR

(Optional) The subject of note (style dependant).

optn

long

The object options: (additive values)
0x00000001=does not display or print
0x00000002=does not print, does display
0x00000004=hyphenated text area or paragraph
0x10000000=special full page bitmap

level

long

If it is a note bookmark, then the level number.

Example

A,N1,(0,0,0,0),"Note ","January 12, 2009 ","Rcv ","Snd ","Test",0,0

Signature

Z, Signature token Record

Syntax

Z,"name",typ,(top,lft,bot,rgt),fid,(red,grn,blu,opt),eff

Parameter

Compiled FAP

Description

Token

CF_REC

The "Z" signature record.

name

CF_STR

The signature name.

type

long

The type: 0=Placeholder, 3=AssureSign, 4=Silanis.

top

long

The top y-coordinate of the rectangle (in UPI units).

lft

long

The left x-coordinate of the rectangle (in UPI units).

bot

long

The bottom y-coordinate of the rectangle (in UPI units).

rgt

long

The right x-coordinate of the rectangle (in UPI units).

fid

long

The font ID.

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

eff

long

The effects:
0 = no special effects
1 = underline
2 = strike-out
3 = underline and strike-out

Example

Z,"Sig ",0,(7818,13300,8043,16500),11212,(0,255,255,3),0

Signature Z1

A,Z1 Document Metadata Record 1

Syntax

A,Z1,flag,len,"data"

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,Z1" text record.

flag

long

The document metadata flag.

len

long

The document metadata length.

data

CF_STR

The document metadata.

Signature Z2

A,Z2 Signature Metadata Record 2

Syntax

A,Z2,flag,len,"data"

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,Z2" text record.

flag

long

The signature metadata flag.

len

long

The signature metadata length.

data

CF_STR

The signature metadata.

Table AQA

A,QA Table Shading Attributes Record

Syntax

A,QAnn,(red,green,blue,options),pattern

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,E" text area record.

red
long
The FAPCOLOR red.
green
long The FAPCOLOR green.
blue
long The FAPCOLOR blue.
options
long The FAPCOLOR options.
pattern
long The pattern.

Remarks

Attaches to the most recent table object. These attributes are stored in the extras attrlistH member of the object descriptor. You can define multiple attributes starting with A,QA, where each is distinguished by the type number following the QA. These attribute types define the shading color and pattern possibilities for a table:

A,QA10  Whole table shade
A,QA11  First row shade
A,QA12  Last row shade
A,QA13  First column shade
A,QA14  Last column shade
A,QA15  Odd banded row shade
A,QA16  Even banded row shade
A,QA17  Odd banded column shade
A,QA18  Even banded column shade

This was added in version 12.1.

Example

A,QA11,(0,255,0,1),0

Text Area AP1

A,P1 Paragraph Record attributes

Syntax

A,P1,lindent,rindent,hindent

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,P1" text area record.

lindent

long

The left indent in FAP units.

rindent

long

The right indent in FAP units.

hindent

long

The hanging indent in FAP units.

Text Area E

M,E Text Area End Record

Syntax

M,E

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,E" text area record.

Remarks

This ends the most recent multiline text definition (Header record).

Text Area G

M,G Text Area Graphic Record

Syntax

M,G,.......

See Record type G for syntax of remaining record.

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,G" text area text record. The 'G' is the start of a normal graphic record.

Remarks

Attaches to the most recent multiline text definition.

Text Area L

M,L Text Area line Record (no longer used)

Syntax

M,L,lid,pid,nchr,nfnt,eop,ht,fid

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,L" text area record.

lid

long

The line ID (1-based integer).

pid

long

The paragraph ID (1-based integer).

nchr

long

The number of characters defined for this line.

nfnt

long

The number of font cross-reference entries required for this line.

eop

long

The end of paragraph flag:
0 = soft return - not end of paragraph
1 = hard return - end of paragraph

ht

long

The height of line, in FAP units.

fid

long

The default font ID.

Remarks

Attaches to the most recent multiline text definition (Header record).

Text Area LL

M,LL Text Area Guide Line Record

Syntax

M,L,.......
See Record type L for syntax of remaining record

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,LL" text area text record. The second 'L' is the start of a normal guide line record.

Remarks

Attaches to the most recent multiline text definition.

Text Area MA

A,MA Text Area Attrlist Attributes Record

Syntax

A,MA...

Parameter

Compiled FAP

Description

Token

CF_REC

The A,MAnn text area attrlist record where nn represents the attribute type.

Text
CF_STR
The text attributes output only a string of text.

Remarks

Attaches to the most recent multiline text definition. These attributes are stored in the extra attrlistH member of the object descriptor. You can define multiple attributes, starting with A,MA, where each is distinguished by the type number that follows the MA. These attribute types define only a text parameter:

A,MA3,style name
A,MA7,task comment
A,MA20,text area prompt

This was added in version 12.1.

Example

A,MA20,Editable Text Area Prompt

Text Area MH

MH Text Area Record

Syntax

M,H,(top,lft,bot,rgt),typ,(fid,fch,fcw,fbl),"nam",ver,sp,tb,ft

Parameter

Compiled FAP

Description

Token

CF_REC

The "MH" text area record.

top

long

The top y-coordinate of the rectangle (in FAP units).

lft

long

The left x-coordinate of the rectangle (in FAP units).

bot

long

The bottom y-coordinate of the rectangle (in FAP units).

rgt

long

The right y-coordinate of the rectangle (in FAP units).

typ

long

The type:
0 = multiline static text area in the composed form section (full contents supplied in FAP ASCII file)
1 = multiline variable text area associated with an entry field (contents supplied in FORM NA Data file)
2 = ? templated multiline area ?

fid

long

The font ID.

fch

long

The font character height.

fcw

long

The font character width.

fbl

long

The font character baseline.

nam

CF_STR

For type 0 - optional name
For type 1 - associated field name

ver

long

The version number (8).

sp

long

The default spacing value.

tb

long

The default tab stop.

ft

long

The format type (fixed, float, column, ...).

spacingType

long

The default spacing type: 0 = SINGLE SPACE 4 = PARA_DOUBLESPACE, 16 = PARA_EXACTSPACE, 32 = PARA_ATLEASTSPACE, 256 = PARA_MULTIPLYSPACE

mtParatmargin

long

The default top margin.

mtParabmargin

long

The default bottom margin.

mtParalindent

long

The default left indent.

mtPararindent

long

The default right indent.

mtParahindent

long

The default hanging indent.

mtParaflags

long

The default paragraph flags.

language

long

The default hyphenation language.

Notes

Subsequent records are attached to this record until the next M(E) ends the text area. Other objects will appear with M, preceding the normal record layout.

Text Area MH1

A,MH1 Text Area Attributes Record 1

Syntax

A,MH1,(red,grn,blu,opt),orn,optn

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,MH1" text area record.

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

orn

long

The orientation (rotation):
0 = normal
90 = downward
180 = upside down
270 = upward

optn

long

The object options (additive values):
0x00000001=does not display or print
0x00000002=does not print, does display
0x00000004=hyphenated text area or paragraph
0x10000000=special full page bitmap

Text Area MH2

A,MH2 Text Area Attributes Record 2

Syntax

A,MH2,prefhgt

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,MH2" text area record.

prefhgt

long

The preferred row height.

Text Area MH4

A,MH4 Text Area Attributes Record MH4

Syntax

A,MH4,lindent,rindent,hindent

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,MH4" text area record.

lindent

long

The left indent in FAP units.

rindent

long

The right indent in FAP units.

hindent

long

The hanging indent in FAP units.

Text Area N

M,N Text Area Note Record

Syntax

M,N,.......
See Record type N for syntax of remaining record

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,N" text area text record. The 'N' is the start of a normal note record.

Remarks

Attaches to the most recent multiline text definition.

Text Area O

M,O Text Area format token Record

Syntax

M,O,(top,lft,bot,rgt), (fid,fch,fcw,fbl),typ,lead

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,O" text area format record.

top

long

The top y-coordinate of the rectangle (in UPI units).

lft

long

The left x-coordinate of the rectangle (in UPI units).

bot

long

The bottom y-coordinate of the rectangle (in UPI units).

rgt

long

The right x-coordinate of the rectangle (in UPI units).

fid

long

The font ID.

fch

long

The font character height.

fcw

long

The font character width.

fbl

long

The font character baseline.

typ

long

The type (end of para, tab char, ...).

lead

long

The leader character.

border

long

The boolean for border.

shade

long

The boolean for shade.

num

long

The number for numbered bullets.

Example

M,O,(2312,7711,2680,7711),(11012,456,400,368),1,0,0,0,0

Text Area O1

M,O1 Text Area format token Record 1

Syntax

M,A,O1,(red,grn,blu,opt),eff

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,O1" text area format record 1.

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

eff

long

The effects (strike-out, underline):
0 = no special effects
1 = underline
2 = strike-out
3 = underline and strike-out

Example

M,A,O1,(0,0,0,0),8

Text Area P

M,P Text Area Paragraph Record

Syntax

M,P,pid,lin,rin,flg,spc,hin,tm,bm

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,P" text area format record.

pid

long

The paragraph ID (1-based integer).

lin

long

The left indent (margin) in 1/100ths of an inch.

rin

long

The right indent (margin) in 1/100ths of an inch.

flg

long

The option flags (additive):
0 = Left justify
1 = Center
2 = Right justify
4 = Double space

spc

long

The line spacing. Reserved for future use.

hin

long

The hanging indent.

tm

long

The top margin.

bm

long

The bottom margin.

Remarks

Attaches to the most recent multiline text definition (Header record).

Example

M,P,0,0,0,0,0,0,0,0

Text Area P1

M,P1 Text Area Paragraph Record 1

Syntax

M,P1,tab,tabtyp,lead

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,P" text area format record.

tab

long

The tab position.

tabtype

long

The tab type (left, right, center, ...).

lead

CF_STR

The leader character.

Remarks

Attaches to the most recent multiline text definition (Paragraph record).

Text Area P2

M,P2 Text Area Paragraph Record 2

Syntax

M,P2,spacing, options, language

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,P2 text area format record.

spacing

long

The paragraph spacing type 0 = SINGLE SPACE 4 = PARA_DOUBLESPACE, 16 = PARA_EXACTSPACE, 32 = PARA_ATLEASTSPACE, 256 = PARA_MULTIPLYSPACE

options

long

The paragraph options.

language

long

The paragraph hyphenation language.

Example

M,P2,4,4,0

Text Area P3

M,P3 Text Area Paragraph Record 3

Syntax

M,P3,BulletType,cp,(PreTabStop, PreTabType, LeadChar),
(PostTabStop, PostTabType, LeadChar),(prefixChars),(postfixChars),
Level,StartPoint,(FontID,fnth,fntw,fntb),(rgbr,rgbg,rgbb,rgbo),effects

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,P3" text area format record.

type

TFAPBULLETTYPE

bullet, number,

name

CF_STR

The logo name.

codePoint

long

The code point of the bullet.

preTab_tabStop

long

The position for the bullet.

preTab_tabType

long

The tab type (left, right, center, ...).

preTab_leadChar

long

The pre tab stop lead character.

postTab_tabStop

long

The position for text.

postTab_tabType

long

The tab type (left, right, center, ...).

postTab_leadChar

long

The post tab stop lead character.

numType

TFAPBULLNUMTYPE

The type of bullet 0 = DECIMAL NUMBER, 1 = UPPER CASE LETTER, 2 = LOWER CASE LETTER, 3 = ROMAN NUMERIAL, 4 = ROMAN NUMERIAL LOWER CASE, 5 = CARDINAL (One, Two, Three), 6 = ORDINAL (1st, 2nd, 3rd), 7 = ORDINAL Text (First, Second, Third)

prefix_1

long

The first char code point of prefix.

prefix_2

long

The second char code point of prefix.

prefix_3

long

The third char code point of prefix.

postfix_1

long

The first char code point of postfix.

postfix_2

long

The second char code point of postfix.

postfix_3

long

The third char code point of postfix.

level

long

The bullet level.

startPoint

long

The start point for vector bullets.

font_id

long

The system global font ID.

font_height

long

The font character height in FAP units.

font_width

long

The font character width in FAP units.

font_baseline

long

The font character baseline in FAP units.

rgbRed

long

The color palette.

rgbGreen

long

The color palette.

rgbBlue

long

The color palette.

rgbOptions

long

The color options.

effects

long

The paragraph effects.

Example

M,P3,4," ",111,(0,0,0),(1200,0,0),0,(65,65,0),(66,66,0),0,1,
(18010,0,0,0),(0,0,0,0),0

Text Area PX

M,PX Text Area Borders/Shades Record

Syntax

M,PX,.......
See Record type X for syntax of remaining record

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,PX" text area border and shade record. The 'X' is the start of normal box record.

Remarks

Attaches to the most recent multiline text definition (Paragraph record).

Text Area T

M,T Text Area Text Record (no longer used)

Syntax

M,T,(top,lft,bot,rgt),(fid,fch,fcw,fbl),lid,lp,len,txt

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,T" text area text record.

top

long

The top y-coordinate of the baseline rectangle.

lft

long

The left x-coordinate of the baseline rectangle.

bot

long

The bottom y-coordinate of the baseline rectangle.

rgt

long

The right x-coordinate of the baseline rectangle.

fid

long

The font ID.

fch

long

The font character height.

fcw

long

The font character width.

fbl

long

The font character baseline.

lid

long

The line ID (line to which it belongs) (1-based integer).

lp

long

The line position (1-based integer).

len

long

The length of text (number of characters).

txt

CF_STR

The text data.

Notes

Attaches to the most recent multiline text definition (Header record). This is no longer used. It is read for compatibility to prior versions but is no longer output.

Text Area TT

M,TT Text Area Text Record

Syntax

M,TT,.......
See Record type T for syntax of remaining record

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,TT" text area text record. The second 'T' is the start of a normal text record.

Remarks

Attaches to the most recent multiline text definition.

Example

M,TT,(2312,7031,2680,7711),(11012,456,400,368),4,Test

Text Area X

M,X Text Area Box Record

Syntax

M,X,.......
See Record type X for syntax of remaining record

Parameter

Compiled FAP

Description

Token

CF_REC

The "M,X" text area text record. The 'X' is the start of a normal box record.

Remarks

Attaches to the most recent multiline text definition.

Text T

T Text Record

Syntax

T,(top,lft,bot,rgt),(fid,fch,fcw,fbl),len,txt

Parameter

Compiled FAP

Description

Token

CF_REC

The "T" text record.

top

long

The top y-coordinate of the rectangle (in UPI units).

lft

long

The left x-coordinate of the rectangle (in UPI units).

bot

long

The bottom y-coordinate of the rectangle (in UPI units).

rgt

long

The right x-coordinate of the rectangle (in UPI units).

fid

long

The font ID (see record type R).

fch

long

The font character height (see record type R).

fcw

long

The font character width (see record type R).

fbl

long

The font character baseline (see record type R).

len

long

The length of text (number of characters).

txt

CF_STR

The text data.

Text T1

A,T1 Text Attributes Record 1

Syntax

A,T1,"tln",orn,(red,grn,blu,opt),eff,optn,"loc"

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,T1" text record.

tln

CF_STR

(Optional) The text label name.

orn

long

The orientation:
0 = normal
90 = downward
180 = upside down
270 = upward

red

long

The color index for red.

grn

long

The color index for green.

blu

long

The color index for blue.

opt

long

The color options.

eff

long

The effects (strike-out, underline):
0 = no special effects
1 = underline
2 = strike-out
3 = underline and strike-out

optn

long

The object options (additive values):
0x00000001=does not display or print
0x00000002=does not print, does display
0x00000004=hyphenated text area or paragraph
0x10000000=special full page bitmap

loc

CF_STR

The locale name.

baselineAdj

long

The adjustment for subscript.

Text T2

A,T2 Text Attributes Record 2

Syntax

A,T2,"name",type,options,parmslen,parms,hreflen,href

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,T2" text record.

T2

CF_STR

The subtype (Text attribute record 2).

Name

CF_STR

The link name.

Type

long

The type: 1=target, 2=href, 4=hot.

Options

long

The PDF link style: 0=None, 1=Solid, 2=Dash, 3=Underline.

ParamsLen

long

The length of the params string.

Params

CF_STR

The HREF parameters used by HTML.

HrefLen

long

The length of the HREF string.

hrefData

CF_STR

The HREF data.

Example

A,T2,"test",2,0,0,,23,http:/&#47www.test.com

Vector I

I Illustration Record

Syntax

I,(top,lft,bot,rgt),typ,pc

Parameter

Compiled FAP

Description

Token

CF_REC

The "I" illustration record.

top

long

The top y-coordinate of the rectangle (in UPI units).

lft

long

The left x-coordinate of the rectangle (in UPI units).

bot

long

The bottom y-coordinate of the rectangle (in UPI units).

rgt

long

The right x-coordinate of the rectangle (in UPI units).

typ

long

The type of object:
0
3 = arc
4 = scanlines
6 = rectangle
7 = ellipse
8 = marker
18 = polyline
20 = winding polygon
22 = alternative polygon
23 = pie
39 = chord
55 = circle
72 = round rectangle

pc

long

The point count for illustration types requiring points.

Example

L,(3750,15375,4750,16575),0,0

Vector I2

A,I2 Illustration Attributes Record 2

Syntax

A,I2,(bx,by),(ex,ey),bangle,eangle

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,I2" field record.

bx

long

The beginning point x for arc/chord/pie (in UPI units).

by

long

The beginning point y for arc/chord/pie (in UPI units).

ex

long

The ending point x for arc/chord/pie (in UPI units).

ey

long

The ending point y for arc/chord/pie (in UPI units).

bangle

long

The beginning angle for arc/chord/pie.

eangle

long

The ending angle for arc/chord/pie.

Example

A,I2,(5,5),(10,5),90,270

Vector I3

A,I3 Illustration Attributes Record 3

Syntax

A,I3,pgr,px1,py1,px2,py2,...,px16,py16

Parameter

Compiled FAP

Description

Token

CF_REC

The "A,I3" field record.

pgr

long

The point group record number), each point group consists of 16 points of x,y  pairs: group record 1 contains points 0 through 15, group record 2 contains characters 16 through 31, and so on. If the number of points is not an even multiple of 16, then fewer points will be on the last attribute record.

px1

long

The x-coordinate in FAP units of the first point in the group.

py1

long

The y-coordinate in FAP units of the first point in the group.

px2

long

... and so on.

py2

long

... and so on.

px16

long

The x-coordinate in FAP units of the 16th point in the group.

py16

long

The y-coordinate in FAP units of the 16th point in the group.

Example

A,I3,0,5,5,10,10,...,80,3

Record Format Reference

NA

\NA=,,,,,,,,,\ Image Header Record

Syntax

\NA=img,pol_ln,duplex,paper,tray,x,y,pa,opt,fd,cp,v,r,gid,ed,et\ EOR

Parameter

Description

Token

The "\NA" header record.

name

The section name (external name, without extension)

pol_Ln

The print options (in any order)
LN=POL line index (1-based)
LN=1 First form line in POL file

duplex

The duplex settings:
DUP=ON
DUP=LB Long binding
DUP=SB Short binding
DUP=OFF

paper

The paper size:
SIZE=x where x will be one of the following for full size documents. L (letter), G (legal), J (executive), I (A4), or a numeric value that cross refernces to the paper size table. For custom-sized sections, legacy versions will show the letter C. Newer environments show the actual size in FAP units, height by width.

tray

The paper tray selection:
TRAY=U upper (or usual) tray
TRAY=L lower tray

x

The base x-coordinate:
X=0

y

The base y-coordinate:
Y=0

parts

(Obsolete) The parts:
PA=1

opt

The section options, represented as letter codes. Secondary option values are represented as a number following a pound (#) sign.

fd

(Obsolete) The send-to copy:
FD=

cp

The copy group:
CG=B1 Select Bin 1

v

The version number:
V=1

r

The revision number:
R=0

g

The GUID (Global Unique ID)
G=abcd1234ef098765abcdef0123456789

d

The effective date
D=20001128

t

The effective time
T=(hex time)

Example

\NA=DECPAGE,LN=1,DUP=OFF,SIZE=L,TRAY=U,X=0,Y=0,PA=,OPT=,FD=,CP=,
V=,R=,G=,D=,T=

B

B;;;;;;;;\ Barcode Record

Syntax

Bfname;l;t;r;b;fid;fmt;scl;rot;opt;bo;rfu\data EOR

Parameter

Description

Token

The "B" bar code record.

fname

The field name.

l

The left coordinate.

t

The top coordinate.

r

The right coordinate.

b

The bottom coordinate.

fid

The font ID.

fmt

The format.

scl

The scale factor.

rot

The rotation.

opt

The options.

bo

The bar code options.

rfu

The reserved "\" end of record header.

data

The data.

DA

DA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Series Label Record

Syntax

DA sname; l_left;l_top;l_right;l_bottom;l_br;l_bg;l_bb;l_bo;
l_btype;l_dlen;l_slen;l_bthick;l_bpat;l_fill;l_fr;l_fg;l_fb;l_fo;
l_fpat;l_type; lr;lg;lb;lo;l_font;l_orient;l_effect;d_opt;\EOR

Parameter

Description

Token

The "DA" Chart Series Label record.

sname

The name of the series (a character string).

left

The left x-coordinate of label.

top

The top y-coordinate of label.

right

The right x-coordinate of label.

bottom

The bottom y-coordinate of label.

br

The red color index for label boundary.

bg

The green color index for label boundary.

bb

The blue color index for label boundary.

bo

The color option for label boundary.

btype

The label boundary type.

dlen

The label boundary dash length.

slen

The label boundary space length.

bthick

The label boundary thickness.

bpat

The label boundary pattern.

fill

Filling label area?

fr

The red color index for filling label.

fg

The green color index for filling label.

fb

The blue color index for filling label.

fo

The color option for filling label.

fpat

The filling pattern label.

type

The type of label.

lr

The red color index for label.

lg

The green color index for label.

lb

The blue color index for label.

lo

The color option for label.

l_font

The font ID for label.

l_orient

The orientation for label.

l_effect

The effects for label.

d_opts

The data options.

rfu

The reserved "\" end of record header.

DB

DB;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Custom Data Point Label Record

Syntax

DB left;top;right;bottom;r;g;b;o;font;orient;effect;\data EOR

Parameter

Description

Token

The "DB" Chart Data Point Label record.

left

The left x-coordinate of custom data point label.

top

The top y-coordinate of custom data point label.

right

The right x-coordinate of custom data point label.

bottom

The bottom y-coordinate of custom data point label.

r

The red color index for custom data point label.

g

The green color index for custom data point label.

b

The blue color index for custom data point label.

o

The color option for custom data point label.

font

The font ID.

orient

The orientation.

effect

The effects.

rfu

The reserved "\" end of record header.

DC

DC;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Area Record

Syntax

DC left;top;right;bottom;br;bg;bb;bo;btype;dlength;slength;bthick;bpat;
fr;fg;fb;fo;fpat;\EOR

Parameter

Description

Token

The "DC" chart area record.

left

The left x-coordinate of chart area.

top

The top y-coordinate of chart area.

right

The right x-coordinate of chart area.

bottom

The bottom y-coordinate of chart area.

br

The red color index for boundary.

bg

The green color index for boundary.

bb

The blue color index for boundary.

bo

The color option for boundary.

btype

The boundary type.

dlen

The boundary dash length.

slen

The boundary space length.

bthick

The boundary thickness.

bpat

The boundary pattern.

fr

The red color index for filling.

fg

The green color index for filling.

fb

The blue color index for filling.

fo

The color option for filling.

fpat

The filling pattern.

rfu

The reserved "\" end of record header.

DD

DD;;\ Dynamic Chart Series Data Record

Syntax

DD sname;fname;\data EOR

Parameter

Description

Token

The "DD" chart series data record.

sname

The name of the series (a character string).

fname

The name of a field.

data

The series data (a numerical value).

DE

DE;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Scale-Axis Record

Syntax

DE max;min;munit;tunit;r;g;b;o;type;dlen;slen;thick;pat;tick;minor;
dtext;left;top;right;bottom;dr;dg;db;do;d_font;d_orient;d_effect;\EOR

Parameter

Description

Token

The "DE" chart scale axis record.

max

The maximum value of the x axis.

min

The minimum value of the x axis.

munit

The unit per minor axis.

tunit

The unit per tick.

r

The red color index for x axis.

g

The green color index for x axis.

b

The blue color index for x axis.

o

The color option for x axis.

type

The axis line type.

dlen

The axis dash length.

slen

The axis space length.

thick

The axis thickness.

pat

The axis pattern.

tick

Show tick.

minor

Show minor axes.

dtext

Show data text.

left

The left x-coordinate of data text.

top

The top y-coordinate of data text.

right

The right x-coordinate of data text.

bottom

The bottom y-coordinate of data text.

dr

The red color index for data text.

dg

The green color index for data text.

db

The blue color index for data text.

dto

The color option for data text.

font

The font ID for data text.

orient

The orientation for data text.

effect

The effects for data text.

rfu

The reserved "\" end of record header.

DK

DK;;\ Dynamic Chart Link Record

Syntax

DK rfu;\cname EOR

Parameter

Description

Token

The "DK" chart link record.

rfu

The reserved "\" end of record header.

cname

The name of chart to link with.

DL

DL;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Legend Record

Syntax

DL left;top;right;bottom;br;bg;bb;bo;btype;dlen;slen;bthick;bpat;
fr;fg;fb;fo;fpat;\EOR

Parameter

Description

Token

"DL" chart legend record

left

The left x-coordinate of chart legend

top

The top y-coordinate of chart legend

right

The right x-coordinate of chart legend

bottom

The bottom y-coordinate of chart legend

br

The red color index for boundary

bg

The green color index for boundary

bb

The blue color index for boundary

bo

The color option for boundary

btype

The boundary type

dlen

The boundary dash length

slen

The boundary space length

bthick

The boundary thickness

bpat

The boundary pattern

fr

The red color index for filling

fg

The green color index for filling

fb

The blue color index for filling

fo

The color option for filling

fpat

The filling pattern

rfu

The reserved "\" end of record header

DN

DN;;\ Dynamic Chart Title Record

Syntax

DN, sname\ EOR

Parameter

Description

Token

"DN" chart title record

sname

The name of the series (a character string)

rfu

The reserved "\" end of record header

DP

DP;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Point-Axis Record

Syntax

DP max;min;munit;tunit;r;g;b;o;type;dlen;slen;thick;pat;tick;minor;
dtext;left;top;right;bottom;dr;dg;db;do;d_font;d_orient;d_effect;\EOR

Parameter

Description

Token

"DP" chart point axis record

max

The maximum value of the y axis

min

The minimum value of the y axis

munit

The unit per minor axis

tunit

The unit per tick

r

The red color index for y axis

g

The green color index for y axis

b

The blue color index for y axis

o

The color option for y axis

type

The axis line type

dlen

The axis dash length

slen

The axis space length

thick

The axis thickness

pat

The axis pattern

tick

Show tick

minor

Show minor axes

dtext

Show data text

left

The left x-coordinate of data text

top

The top y-coordinate of data text

right

The right x-coordinate of data text

bottom

The bottom y-coordinate of data text

dr

The red color index for data text

dg

The green color index for data text

db

The blue color index for data text

dto

The color option for data text

font

The font ID for data text

orient

The orientation for data text

effect

The effects for data text

rfu

The reserved "\" end of record header

DS

DS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Series Record

Syntax

DS sname;nr;ng;nb;no;n_font;n_orient;n_effect;
br;bg;bb;bo;btype;dlen;slen;bthick;bpat;
fill;fr;fg;fb;fo;fpat;marker;msize;exp;fname;\title EOR
(Followed by a DA and a group of DD's)

Parameter

Description

Token

The "DS" chart series record.

sname

The name of the series (a character string).

nr

The red color index for series name.

ng

The green color index series name.

nb

The blue color index for series name.

no

The color option for series name.

n_font

The font ID for series name.

n_orient

The orientation for series name.

n_effect

The effects for series name.

br

The red color index for boundary.

bg

The green color index for boundary.

bb

The blue color index for boundary.

bo

The color option for boundary.

btype

The boundary type.

dlen

The boundary dash length.

slen

The boundary space length.

bthick

The boundary thickness.

bpat

The boundary pattern.

fill

Filling this series.

fr

The red color index for filling.

fg

The green color index for filling.

fb

The blue color index for filling.

fo

The color option for filling.

fpat

The filling pattern.

marker

The marker type.

msize

The marker size.

exp

The explode %.

fname

The field name.

title

The title.

DT

DT;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Title Record

Syntax

DT left;top;right;bottom;r;g;b;o;font;orient;effect;\data EOR

Parameter

Description

Token

The "DT" chart title record.

left

The left x-coordinate of title.

top

The top y-coordinate of title.

right

The right x-coordinate of title.

bottom

The bottom y-coordinate of title.

r

The red color index for title.

g

The green color index for title.

b

The blue color index for title.

o

The color option for title.

font

The font ID.

orient

The orientation.

effect

The effects.

rfu

The reserved "\" end of record header.

data

The title character data.

DX

DX;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart X-Axis Record

Syntax

DX max;min;munit;tunit;r;g;b;o;type;dlen;slen;thick;pat;tick;minor;
dtext;left;top;right;bottom;dr;dg;db;do;d_font;d_orient;d_effect;\EOR
(followed by DT)

Parameter

Description

Token

The "DX" chart X-axis data record.

max

The maximum value of the x axis.

min

The minimum value of the x axis.

munit

The unit per minor axis.

tunit

The unit per tick.

r

The red color index for x axis.

g

The green color index for x axis.

b

The blue color index for x axis.

o

The color option for x axis.

type

The axis line type.

dlen

The axis dash length.

slen

The axis space length.

thick

The axis thickness.

pat

The axis pattern.

tick

Show tick.

minor

Show minor axes.

dtext

Show data text.

left

The left x-coordinate of data text.

top

The top y-coordinate of data text.

right

The right x-coordinate of data text.

bottom

The bottom y-coordinate of data text.

dr

The red color index for data text.

dg

The green color index for data text.

db

The blue color index for data text.

dto

The color option for data text.

font

The font ID for data text.

orient

The orientation for data text.

effect

The effects for data text.

rfu

The reserved "\" end of record header.

Notes

This record is no longer used. The scale and point axis records are now used.

DY

DY;;;;;;;;;;;;;;;;;;;;;;;;;;\ Dynamic Chart Y-Axis Record

Syntax

DY max;min;munit;tunit;r;g;b;o;type;dlen;slen;thick;pat;tick;minor;
dtext;left;top;right;bottom;dr;dg;db;do;d_font;d_orient;d_effect;\EOR
(followed by DT)

Parameter

Description

Token

The "DY" chart Y-axis data record.

max

The maximum value of the y axis.

min

The minimum value of the y axis.

munit

The unit per minor axis.

tunit

The unit per tick.

r

The red color index for y axis.

g

The green color index for y axis.

b

The blue color index for y axis.

o

The color option for y axis.

type

The axis line type.

dlen

The axis dash length.

slen

The axis space length.

thick

The axis thickness.

pat

The axis pattern.

tick

Show tick.

minor

Show minor axes.

dtext

Show data text.

left

The left x-coordinate of data text.

top

The top y-coordinate of data text.

right

The right x-coordinate of data text.

bottom

The bottom y-coordinate of data text.

dr

The red color index for data text.

dg

The green color index for data text.

db

The blue color index for data text.

dto

The color option for data text.

font

The font ID for data text.

orient

The orientation for data text.

effect

The effects for data text.

rfu

The reserved "\" end of record header.

Notes

This record is no longer used. The scale and point axis records are now used.

EM

EM;\ End Multiline Field Structure

Syntax

EM;rfu\EOR

Parameter

Description

Token

The "EM" End multiline field record.

rfu

The reserved "\" end of record header.

ENDDOCSET

\ENDDOCSET\ Form set Trailer Record

Syntax

\ENDDOCSET\     info EOR
\ENDDOCSET\ = record type

Parameter

Description

Token

The "\ENDDOCSET" record. Denotes end of a form set.

info

The application dependant information describing the form set such as:
"==> 2196564" denotes a policy number.

ENDFAP

\ENDFAP\ End in-line FAP file records

Syntax

\ENDFAP\    EOR
\ENDFAP\ = record type

Parameter

Description

Token

The "\ENDFAP\" record. Denotes the end of an in-line FAP file.

ENDFORM

\ENDFORM\ Form Trailer Record

Syntax

\ENDFORM\ EOR

Parameter

Description

Token

The "\ENDFORM" record. Denotes the end of a form, page, or related set of sections (segments.)

F

F;;;;;;\ Field Data Record

Syntax

Ffname;x;y;fid;opt;msg;rfu\data EOR

Parameter

Description

Token

The "F" field data record.

fname

The field name.

x

The baseline left x-coordinate absolute relative to (0,0).

y

The baseline bottom y-coordinate absolute relative to (0,0).

fid

The font ID.

opt

The option flags:
E = Error
M = Manual entry
P = Protected
G = Global Scope - to the entire form set
F = Global Scope - to the form
H = Hidden field (also known as a dummy field, or a no display, no print field)
N = Nonprintable field (display only, no print)
C = Send Copy To field (receives current recipient name at print time)
9 = Rotated 90 degrees
8 = Rotated 180 degrees
7 = Rotated 270 degrees

msg

The information/message.

rfu

The reserved "\" end of record header.

data

The field character data.

Example
FFIELD;866;18350;16110;;;\Text

FAP

\FAP\ Begin in-line FAP file records

Syntax

\FAP\   EOR
\FAP\ = record type

Parameter

Description

Token

The "\FAP\" record. Denotes the beginning of an in-line FAP file.

L

L;;;;;;\ Old Multiline Field Line Attribute Record.

No longer used.

Syntax

Llid;pid;nchr;nfnt;eop;ht;fid;rfu\EOR

Parameter

Description

Token

The "L" multiline field line attribute record

lid

The line ID (1-based integer).

pid

The paragraph ID (1-based integer).

nchr

The number of characters defined for this line.

nfnt

The number of font cross reference entries required for this line.

eop

The end of paragraph flag:
0 = soft return - not end of paragraph
1 = hard return - end of paragraph

ht

The height of line.

fid

The default font ID.

rfu

The reserved "\" end of record header.

M

M;;;;;;;;;;\ Multiline Field Structure

Syntax

Mfname;lft;top;rgt;bot;fid;maxl;spc;ver;tab;fmt;spt;rfu\EOR

Parameter

Description

Token

The "M" multiline field record.

fname

The multiline field name.

lft

The left x-coordinate of the rectangle.

top

The top y-coordinate of the rectangle.

rgt

The right x-coordinate of the rectangle.

bot

The bottom y-coordinate of the rectangle.

fid

The default font ID.

maxl

The maximum lines allowed (0 = use internal default, 255).

spc

The line spacing.

ver

The version (8).

tab

The tab stop.

fmt

The format type (fixed, flow, and so on).

spt

The spacing type.

rfu

The reserved "\" end of record header.

M1

MRO;;;;;;;;;;\ Object Type Structure

Syntax

\MRO=;objecttype; name1;name2;name3;omit;tag;

Parameter                                  

Description

objecttype

Object type is the type of the object.

2 represents the global context tag for the document. In this case, name1; name2; and name3 will be blank.

3 indicates that the tag applies at the group or form list level. In this case, name1; name2; and name 3 will be the key values associated with the group. The values will be blank if not in use.

4 indicates that the tag applies to forms. In this case, name 1 will be the name of the form. Name2 and name3 will be blank.

Omit

Default value 0. When Omit is enabled, the value is 1.

Tag

Represents the actual context tag value.

N

N;;;;;;;;\ Note Record

Syntax

Nname;date;rec;send;sub;lft;top;rgt;bot;r;g;b;o;opt;ty;sty;rfu\data EOR

Parameter

Description

Token

The "N" note record.

name

The note name.

date

The date.

rec

The receiver.

send

The sender.

sub

The subject.

lft

The left x-coordinate of the baseline rectangle.

top

The top y-coordinate of the baseline rectangle.

rgt

The right x-coordinate of the baseline rectangle.

bot

The bottom y-coordinate of the baseline rectangle.

r

(Optional) The color index for red.

g

(Optional) The color index for green.

b

(Optional) The color index for blue.

o

(Optional) The color options.

opt

The options.

ty

The type.

sty

The style.

rfu

The reserved "\" end of record header.

data

The data text of note.

O

O;;;;;;;;;;;\ Multiline Format Record

Syntax

O;lft;top;rgt;bot;fid;typ;lead;brd;shd;eff;rfu\

Parameter

Description

Token

"O" Multiline format record.

lft

The left x-coordinate of the baseline rectangle.

top

The top y-coordinate of the baseline rectangle.

rgt

The right x-coordinate of the baseline rectangle.

bot

The bottom y-coordinate of the baseline rectangle.

fid

The font ID.

typ

The format type (end of para, tab character).

lead

The leader character (ASCII value).

brd

The border.

shd

The shade.

eff

The effects.

rfu

The reserved "\" end of record header.

OX

OX;;;;;\ Multiline Border or Shade Record

Syntax

OX;.....
See Record type X for syntax of remaining record

Parameter

Description

Token

"OX" Multiline field border or shade record

P

P;;;;;\ Multiline Field Paragraph Format Record

Syntax

Ppid;lin;rin;flags;spc;hin;tm;bm;spt;rfu\EOR

Parameter

Description

Token

The "P" Multiline field paragraph format record.

pid

The paragraph ID (1-based integer). Not used after version 8.0. It is set to zero (0).

lin

The left indent (margin).

rin

The right indent (margin).

flags

The option flags (additive):
0 = left justify (normal)
1 = center
2 = right justify
4 = double space
8 = justify (left/right)

spc

The line spacing amount.

hin

The hanging indent.

tm

The top margin.

bm

The bottom margin.

spt

The line spacing type.

rfu

The reserved "\" end of record header.

P3

P3;;;;;\ Text Area Format Record P3

Syntax

P3;type;name;codePoint;preTab_tabStop;preTab_tabType;preTab_leadChar;
postTab_tabStop;postTab_tabType;postTab_leadChar;numType;prefix_1;
prefix_2;prefix_3;postfix_1;postfix_2;postfix_3;level;startPoint;
font_id;font_height,font_width;font_baseline;rgbRed;rgbGreen;rgbBlue;
rgbOptions;effects;rfu\EOR

Parameter

Description

Token

The "P3" Text area format record.

type

The bullet type.

name

The logo name.

codePoint

The code point or ID of bullet.

preTab_tabStop

The position for bullet.

preTab_tabType

The tab type (left, right, center, and so on).

preTab_leadChar


postTab_tabStop

The position for text.

postTab_tabType

The tab type (left, right, center, and so on).

postTab_leadChar


numType

The number type.

prefix_1

The first char code point of prefix.

prefix_2

The second char code point of prefix.

prefix_3

The third char code point of prefix.

postfix_1

The first char code point of postfix.

postfix_2

The second char code point of postfix.

postfix_3

The third char code point of postfix.

level


startPoint


font_id


font_height


font_width


font_baseline


rgbRed


rgbGreen


rgbBlue


rgbOptions


effects


rfu

The reserved "\" end of record header.

PBG

PB;G;;;;;\ Text Area Format Record G

Syntax

PB;G;top;left;bottom;right;rfu\EOR

Parameter

Description

Token

The "G" Text area format record.

top

The rectangle's top coordinate.

left

The rectangle's left coordinate.

bottom

The rectangle's bottom coordinate.

right

The rectangle's right coordinate.

rfu


PBG1

PB;G1;;;;;\ Text Area Format Record G1

Syntax

PB;G1;type;resolut;redcolr;grncolr;blucolr;optcolr;orient;style;
name;inlineBM;options;rfu\EOR

Parameter

Description

Token

The "G1" Text area format record.

type


resolut


redcolr


grncolr


blucolr


optcolr


orient


style


name


inlineBM


options


rfu

The reserved "\" end of record header.

PBI

PB;I;;;;;\ Text Area Format Record I

Syntax

PB;I;type;cord_top;cord_left;cord_bottom;cord_right;cord_type;
pointCount;rfu\EOR

Parameter

Description

Token

The "I" Text area format record.

cord_top

The rectangle's top coordinate.

cord_left

The rectangle's left coordinate.

cord_bottom

The rectangle's bottom coordinate.

cord_right

The rectangle's right coordinate.

type

The vector type.

pointCount

The number of poly points.

rfu

The reserved "\" end of record header.

PBI1

PB;I1;;;;;\ Text Area Format Record I1

Syntax

PB;I1;name;pen_color_rgbRed;pen_color_rgbGreen;pen_color_rgbBlue;
pen_color_rgbOptions;pen_style;pen_width;brush_fgColor_rgbRed;
brush_fgColor_rgbGreen;brush_fgColor_rgbBlue;
brush_fgColor_rgbOptions;brush_bgColor_rgbRed;brush_bgColor_rgbGreen;
brush_bgColor_rgbBlue;brush_bgColor_rgbOptions;brush_style;
PatternName;rfu\EOR

Parameter

Description

Token

The "I1" Text Area Format Record.

name

The name of the object.

pen_color_rgbRed

The pen color.

pen_color_rgbGreen


pen_color_rgbBlue


pen_color_rgbOptions


pen_style

The pen style.

pen_width

The pen width.

brush_fgColor_rgbRed

The brush foreground color.

brush_fgColor_rgbGreen


brush_fgColor_rgbBlue


brush_fgColor_rgbOptions


brush_bgColor_rgbRed

The brush background color.

brush_bgColor_rgbGreen


brush_bgColor_rgbBlue


brush_bgColor_rgbOptions


brush_style

The brush style.

PatternName

The customized name.

rfu

The reserved "\" end of record header.

PBT

PB;T;;;;;\ Text Area Format Record T

Syntax

PB;T;top;left;bottom;right;fontid;fonthi;fontwi;fontba;len;
pointCount;rfu\EOR

Parameter

Description

Token

"T" Text area format record.

top

The rectangle's top coordinate.

left

The rectangle's left coordinate.

bottom

The rerectangle's bottom coordinate.

right

The rectangle's right coordinate.

fontid

The font ID.

fonthi

The font height.

fontwi

The font width.

fontba

The font baseline.

len

The text length.

rfu


PBT1

PB;T1;;;;;\ Text Area Format Record T1

Syntax

PB;T1;name;orientation;rgbRed;rgbGreen;rgbBlue;rgbOpts;effects;
options;locale;rfu\EOR

Parameter

Description

Token

"T1" Text area format record.

name

The name of the object.

orient

The orientation.

rgbRed

The color.

rgbGreen


rgbBlue


rgbOpts


effects

The effects.

options

The options.

locale


rfu

The reserved "\" end of record header.

PE

PE;;;;;\ Multiline Field Paragraph Format Record

Syntax

PE,type,rfu\EOR

Parameter

Description

Token

The "PE" Multiline field paragraph format record.

type

The box type.

rfu

The reserved "\" end of record header.

PT

PT;;;;;\ ... Multiline Field Paragraph Tab Stop Record

Syntax

PT;tab;tabtyp;lead;rfu\EOR

Parameter

Description

Token

The "PT" Multiline field paragraph format tab stop record.

tab

The tab stop.

tabtyp

The tab type (left, right, center).

lead

The leader character (ASCII value).

rfu

The reserved "\" end of record header.

PX

PX;;;;;\ Multiline Field Paragraph Border or Shade Record

Syntax

PX;.....

Parameter

Description

Token

The "PX" Multiline field paragraph border or shade record.

Notes

See Record type X for syntax of remaining record

T

T;;;;;;\ Dynamic (and Multiline Field) Text Data Record

Syntax

Tfname;lft;top;rgt;bot;fid;lid;lp;r;g;b;o;rfu\data EOR

Parameter

Description

Token

The "T" multiline field text record.

fname

(Optional) The template field source name. This will be blank if it flowed from canned text.

lft

The left x-coordinate of the baseline rectangle.

top

The top y-coordinate of the baseline rectangle.

rgt

The right x-coordinate of the baseline rectangle.

bot

The bottom y-coordinate of the baseline rectangle.

fid

The font ID.

lid

The line ID - the line to which it belongs (1-based integer). Not used after version 8.0.

lp

The line position (1-based integer). Not used after version 8.0.

r

(Optional) The color index for red .

g

(Optional) The color index for green.

b

(Optional) The color index for blue.

o

(Optional) The color options.

baselineAdj

Baseline adjustment value for superscript/subscript.

uid

Unique identifier string (ID).

ignore

Accessibility setting to tell screen readers to ignore text.

rfu

Reserved "\" end of record header.

data

The character text data.

Notes

This record may occur outside of a multiline merged text structure, in which case it is dynamically loaded text, similar to dynamic boxes and logos.

The highlighted '1' below shows the ignore flag being set for T records generated for PDF417 barcodes (PDF417 barcodes are printed using text records with a PDF417 font).

The ignore flag is used when generating accessible PDF file in order to tell a screen reader to ignore this text (OOEDFKCHCA_IIHNCDM...)

TP417BX4;3000;6669;17400;6749;1216;0;0;0;0;0;0;0;0;;1;\OOEDFKCHCA_IIHNCDM_HLGKACJDBDAJA_FKINFGDACJFCIIDAK_IAMLDBCKJHHDAAIJ_HDDHFJC_BNNDAMFGHONHJA

X

X;;;;;;;;\ ... Dynamic Line\Box Record

Syntax

Xlft;top;rgt;bot;hth;vth;typ;pat;gap;ef;r;g;b;o
tbw,lbw,bbw,rbw,tbg,lbg,bbg,rbg,tbs,lbs,bbs,rbs\ EOR

Parameter

Description

Token

The "N" dynamic line\box record.

left

The left x-coordinate of the rectangle.

top

The top y-coordinate of the rectangle.

right

The right x-coordinate of the rectangle.

bot

The bottom y-coordinate of the rectangle.

hth

The horizontal thickness.

vth

The vertical thickness.

typ

The type of object.

pat

The type of pattern.

gap

The gap for the border.

effects

The effects (additive):
0 = all sides of box
1 = top
2 = bottom
4 = left
8 = right

r

(Optional) The color index for red .

g

(Optional) The color index for green .

b

(Optional) The color index for blue .

o

(Optional) The color options .

lc

The line count.

tbw

The top box width.

lbw

The left box width.

bbw

The bottom box width.

rbw

The right box width.

tbg

The top box gap.

lbg

The left box gap.

bbg

The bottom box gap.

rbg

The right box gap.

tbs

The top box style.

lbs

The left box style.

bbs

The bottom box style.

rbs

The right box style.

Z

Z ;;;;;;;;;;;;\ Signature token Record

Syntax

Z name;typ;top;lft;bot;rgt;fid;red;grn;blu;opt;eff;\

Parameter

Description

Token

The "Z " signature record

name

The signature name.

type

0 = PDF placeholder, 3 = AssureSign, 4 = Silanis.

left

The left x-coordinate of the rectangle.

top

The top y-coordinate of the rectangle.

right

The right x-coordinate of the rectangle.

bot

The bottom y-coordinate of the rectangle.

fid

The font ID.

r

The color index for red.

g

The color index for green.

b

The color index for blue.

o

The color options.

eff

The effects.

Z1

Z1;;\ Signature Document Metadata Record

Syntax

Z1;flag;len;\data

Parameter

Description

Token

The "Z1" document metadata.

flag

The flag.

len

The length.

data

The document metadata.

Z2

Z2;;\ Signature Metadata Record

Syntax

Z2;flag;len;\data

Parameter

Description

Token

The "Z2" signature metadata.

flag

The flag.

len

The length.

data

The signature metadata.

Global Types

CF_REC

typedef struct CF_REC 
char RecordType[ ( 4 ) ]

Record type token.

CF_START

typedef struct CF_START 
char RecordType[ ( 4 ) ]

Record type token.

long LibraryVersion

The library version number.

CF_STR

typedef struct CF_STR 
size_t StringLen

The length of string, including NULL.

char* StringValue

The string value.



Providing Form Inclusion Information

With version 12.0 and higher, Documaker writes form inclusion information into output files. This means triggers are retained in the resulting transaction set for groups, forms, and sections. This can help you determine which events led to the resulting document set.

In NAFILE output, additional records hold the trigger information. An example of the layout is shown here:

\TRIG=;TriggerName; ObjectTypeNumber; Name; SecondName; ThirdName;
TransactionCodes; Recipients; SearchMask; RequiredFlags; CopyCount;
ConditionalMask; FunctionName; RuleData; ItemsTriggered;
TriggerDescription;

The trigger's name is included at the start of the line. For instance, you will see Manual if it is a non-DAL trigger (the legacy SetRecip trigger rule). The system distinguishes between the group, form, and section trigger records by including a name in the record, as this table shows:

Record  Type

Placement in NA

Format

Group
Top of file, after any addressee records
\TRIG=;TriggerName;3;GroupName1;GroupName2;GroupName3;
Form
Before the first section of the form
\TRIG=;TriggerName;4;FormName; ; ;
Section
After the section \NA header line
\TRIG=;TriggerName;6;SectionName; ; ;

In the XML output (exported or printed) the trigger information is output in the same way it is stored in regular resources except the < TRIGCOUNT > node indicates the number of items included by the trigger. Here is an example of a group trigger entry in the NA file using DAL triggers:

\TRIG=;ALWAYS;3;FSI;GL;;;;;1;1;;DALTRIGGER;ALWAYS;1;This is my trigger description;
\TRIG=;ALWAYS;3;FSI;GL;Extra;;;;1;1;;DALTRIGGER;ALWAYS;1;;

Here is an example of the form entry:

\TRIG=;Manual;4;FCG 0001 04 93;;;T1;INSURED,COMPANY;11,HEADERREC,98,~0;0;1;;;;1;;

Here is an example of the section entry:

\TRIG=;ALWAYS;6;q1snam;;;;AGENT(1),COMPANY(1),INSURED(1);;1;1;;DALTRIGGER;ALWAYS;1;;

Here is an example of a form entry in the NA file for a SetRecip (manual) trigger:

\TRIG=;Manual;4;MEDICAL HISTORY USING MEDBODY1;;;;;;0;0;10,TREATMENT;;;1;;

Here is an example of a section entry for a SetRecip trigger:

\TRIG=;Manual;6;MEDBODY1;;;;AGENT,HOMEOFFICE,INSURED;10,TREATMENT;1;1;;;;35;;

Note: To produce form inclusion records, you must have an MRL created in Studio. You must also include the RunTriggers rule in your AFGJOB.JDT file.